Skip to content

README: document fix-up needed for esp8266 platform overlay #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

README: document fix-up needed for esp8266 platform overlay #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,19 @@ From the indexes you create overlays which then make the Arduino packages and li
));
}
```
## Fix-ups for specific platforms

Some platform packages need fix-ups to work usefully; this can often be done by overriding the derivation for the platform package. Platforms that are currently known to need this are documented in this section.

### esp8266

The esp8266 core package has some convoluted code around enabling and disabling "aggressive core caching"; this seems to rely on a file `cores/esp8266/CommonHFile.h` either already existing or being created on first use. Obviously the nix store is read-only so this must be done when the derivation for the package is built:
```
...
packages = with pkgs.arduinoPackages; [
(platforms.esp8266.esp8266."3.1.2".overrideAttrs {
postInstall = "touch $out/$dirName/cores/esp8266/CommonHFile.h";
})
]
...
```