mwojcik/thermostat
1
0
Fork 0
forked from M-Labs/thermostat
Code Issues Pull Requests Projects Releases Wiki Activity

Compare commits

base: mwojcik:e749a969710adb38022a8630aa6388f0aa369d5a
Branches Tags
mwojcik:master
mwojcik:nixflakes
mwojcik:shorter_main
mwojcik:softspi
M-Labs:master
M-Labs:dev-gui
M-Labs:GUI
M-Labs:softspi
..
compare: mwojcik:2108ab0782a643aff812d9f0f95a0ffaeaeb57c1
Branches Tags
mwojcik:nixflakes
mwojcik:master
mwojcik:shorter_main
mwojcik:softspi
M-Labs:master
M-Labs:dev-gui
M-Labs:GUI
M-Labs:softspi

2 Commits
e749a96971 ... 2108ab0782

Author SHA1 Message Date
mwojcik
2108ab0782 readme: update build instructions for flakes 2022-01-18 10:55:52 +08:00
mwojcik
af9f3903be flakes: cleanup 2022-01-18 10:55:26 +08:00
2 changed files with 75 additions and 81 deletions
Show Stats Expand all files Collapse all files

12
README.md
View File

@ -8,20 +8,22 @@
### Reproducible build with Nix ### Reproducible build with Nix
See the `mcu` folder of the [nix-scripts repository](https://git.m-labs.hk/M-Labs/nix-scripts). Thermostat firmware is packaged using the [Nix](https://nixos.org) Flakes system. Install Nix 2.4+ and enable flakes by adding ``experimental-features = nix-command flakes`` to ``nix.conf`` (e.g. ``~/.config/nix/nix.conf``).
Once you have Flakes enabled, you can use ``nix build`` to build the firmware.
### Development environment ### Development environment
Clone this repository and [nix-scripts](https://git.m-labs.hk/M-Labs/nix-scripts). Clone this repository and with Nix Flakes enabled, use the following commands:
```shell ```shell
nix-shell -I nix-scripts=[path to nix-scripts checkout] nix develop
cargo build --release cargo build --release
``` ```
The resulting ELF file will be located under `target/thumbv7em-none-eabihf/release/thermostat` The resulting ELF file will be located under `target/thumbv7em-none-eabihf/release/thermostat`.
Alternatively, you can install the Rust toolchain without Nix using rustup; see the channel manifest file in nix-scripts (`channel-rust-nightly.toml`) to determine which Rust version to use. Alternatively, you can install the Rust toolchain without Nix using rustup; see the Rust manifest file pulled in `flake.nix` to determine which Rust version to use.
## Debugging ## Debugging

144
flake.nix
View File

@ -1,87 +1,79 @@
{ {
description = "Firmware for the Sinara 8451 Thermostat"; description = "Firmware for the Sinara 8451 Thermostat";
inputs.nixpkgs.url = github:NixOS/nixpkgs/nixos-21.11; inputs.nixpkgs.url = github:NixOS/nixpkgs/nixos-21.11;
inputs.mozilla-overlay = { url = github:mozilla/nixpkgs-mozilla; flake = false; }; inputs.mozilla-overlay = { url = github:mozilla/nixpkgs-mozilla; flake = false; };
outputs = { self, nixpkgs, mozilla-overlay }: outputs = { self, nixpkgs, mozilla-overlay }:
let let
pkgs = import nixpkgs { system = "x86_64-linux"; overlays = [ (import mozilla-overlay) ]; }; pkgs = import nixpkgs { system = "x86_64-linux"; overlays = [ (import mozilla-overlay) ]; };
rustManifest = pkgs.fetchurl { rustManifest = pkgs.fetchurl {
url = "https://static.rust-lang.org/dist/2020-10-30/channel-rust-nightly.toml"; url = "https://static.rust-lang.org/dist/2020-10-30/channel-rust-nightly.toml";
sha256 = "0iygcwzh8s0lfdghj5809krvzifc1ii1wm4sd3qqn7s0rz1s14hi"; sha256 = "0iygcwzh8s0lfdghj5809krvzifc1ii1wm4sd3qqn7s0rz1s14hi";
}; };
targets = [ targets = [
"thumbv7em-none-eabihf" "thumbv7em-none-eabihf"
]; ];
rustChannelOfTargets = _channel: _date: targets: rustChannelOfTargets = _channel: _date: targets:
(pkgs.lib.rustLib.fromManifestFile rustManifest { (pkgs.lib.rustLib.fromManifestFile rustManifest {
inherit (pkgs) stdenv lib fetchurl patchelf; inherit (pkgs) stdenv lib fetchurl patchelf;
}).rust.override { }).rust.override {
inherit targets; inherit targets;
extensions = ["rust-src"]; extensions = ["rust-src"];
}; };
rust = rustChannelOfTargets "nightly" null targets; rust = rustChannelOfTargets "nightly" null targets;
rustPlatform = pkgs.recurseIntoAttrs (pkgs.makeRustPlatform { rustPlatform = pkgs.recurseIntoAttrs (pkgs.makeRustPlatform {
rustc = rust; rustc = rust;
cargo = rust; cargo = rust;
}); });
thermostat = rustPlatform.buildRustPackage rec { thermostat = rustPlatform.buildRustPackage rec {
name = "thermostat"; name = "thermostat";
version = "0.0.0"; version = "0.0.0";
src = self; src = self;
cargoLock = { cargoLock = {
lockFile = ./Cargo.lock; lockFile = ./Cargo.lock;
outputHashes = { outputHashes = {
"stm32-eth-0.2.0" = "sha256-HXRr/NDhdIKqyjdA4D8ZmcO1dDpDawdlYPUOwcEbPQk="; "stm32-eth-0.2.0" = "sha256-HXRr/NDhdIKqyjdA4D8ZmcO1dDpDawdlYPUOwcEbPQk=";
"stm32f4xx-hal-0.8.3" = "sha256-MOv7tVtVMxr3IYMaN0Q8EQWxv3rubmCxjXMXuw/ZKAw="; "stm32f4xx-hal-0.8.3" = "sha256-MOv7tVtVMxr3IYMaN0Q8EQWxv3rubmCxjXMXuw/ZKAw=";
}; };
}; };
patchPhase = ""; nativeBuildInputs = [ pkgs.llvm ];
nativeBuildInputs = [ pkgs.llvm ]; buildPhase = ''
buildPhase = '' cargo build --release --bin thermostat
export CARGO_HOME=$(mktemp -d cargo-home.XXX) '';
cargo build --release --bin thermostat
'';
checkPhase = '' installPhase = ''
cargo test --target=${pkgs.rust.toRustTarget pkgs.stdenv.targetPlatform}; mkdir -p $out $out/nix-support
''; cp target/thumbv7em-none-eabihf/release/thermostat $out/thermostat.elf
echo file binary-dist $out/thermostat.elf >> $out/nix-support/hydra-build-products
llvm-objcopy -O binary target/thumbv7em-none-eabihf/release/thermostat $out/thermostat.bin
echo file binary-dist $out/thermostat.bin >> $out/nix-support/hydra-build-products
'';
# binaryName defaults to the `name` arg (i.e. the Rust package name); dontFixup = true;
# it is used as the Cargo binary filename };
installPhase = '' in rec {
mkdir -p $out $out/nix-support packages.x86_64-linux = rec {
cp target/thumbv7em-none-eabihf/release/thermostat $out/thermostat.elf inherit thermostat;
echo file binary-dist $out/thermostat.elf >> $out/nix-support/hydra-build-products };
llvm-objcopy -O binary target/thumbv7em-none-eabihf/release/thermostat $out/thermostat.bin
echo file binary-dist $out/thermostat.bin >> $out/nix-support/hydra-build-products
'';
dontFixup = true; hydraJobs = {
}; inherit (packages.x86_64-linux) thermostat;
in rec { };
packages.x86_64-linux = rec {
inherit thermostat;
};
hydraJobs = { devShell.x86_64-linux = pkgs.mkShell {
inherit (packages.x86_64-linux) thermostat; name = "thermostat-dev-shell";
}; buildInputs = with pkgs; [
rustPlatform.rust.rustc
devShell.x86_64-linux = pkgs.mkShell { rustPlatform.rust.cargo
name = "thermostat-dev-shell"; gcc openocd dfu-util
buildInputs = with pkgs; [ ] ++ (with python3Packages; [
rustPlatform.rust.rustc numpy matplotlib
rustPlatform.rust.cargo ]);
gcc openocd dfu-util };
] ++ (with python3Packages; [ defaultPackage.x86_64-linux = thermostat;
numpy matplotlib };
]);
};
defaultPackage.x86_64-linux = thermostat;
};
} }