Platformio: Difference between revisions

(3 intermediate revisions by one other user not shown)

Line 3:

== Basic development environment ==

<~~syntaxHighlight~~ lang=nix>

{ pkgs ? import <nixpkgs> {} }:

let

in

pkgs.mkShell {

buildInputs = [

buildInputs = with pkgs; [

~~pkgs.~~platformio

platformio

# optional: needed as a programmer i.e. for esp32

~~# pkgs.~~avrdude

avrdude

];

}

</~~syntaxHighlight~~>

</syntaxhighlight>

== NixOS ==

Line 20:

Add the required udev rules.

<~~syntaxHighlight~~ lang=nix>

{

services.udev.packages = [

services.udev.packages = with pkgs; [

~~pkgs.~~platformio-core

platformio-core.udev

~~pkgs.~~openocd

openocd

];

}

</~~syntaxHighlight~~>

</syntaxhighlight>

== Use in vscode ==

Line 40:

</syntaxHighlight>

[https://discourse.nixos.org/t/how-to-use-platformio-with-vscode/15805/3 As of PlatformIO IDE 2.0.0], you will need a shell that allows the extension to run “python -m platformio” ([https://github.com/NixOS/nixpkgs/pull/237313 #237313]):

[https://discourse.nixos.org/t/how-to-use-platformio-with-vscode/15805/3 As of PlatformIO IDE 2.0.0], <s>you will need a shell that allows the extension to run “python -m platformio” ([https://github.com/NixOS/nixpkgs/pull/237313 #237313])</s>:

Recently (2024?) simply building an FHS shell with the referred <code>nixpkgs</code> commit doesn't work anymore. The modification is probably incompatible with newer <code>nixpkgs</code>.

<~~syntaxHighlight~~ lang=~~nix~~>

There's a quick&dirty fix available as a <code>flake</code> <code>devShell</code>. For usage with <code>direnv</code> (recommended), make an <code>.envrc</code> in your project dir like this:<syntaxhighlight lang="bash">

~~{ pkgs ? import (builtins.fetchTarball {~~

#!/usr/bin/env bash

# ~~NixOS~~/~~nixpkgs#237313~~ = ~~ppenguin:refactor~~-~~platformio~~-~~fix~~-~~ide~~

~~url~~ = "https://github.com/~~NixOS~~/~~nixpkgs~~/~~archive~~/~~3592b10a67b518700002f1577e301d73905704fe.tar.gz";~~

PRJROOT="$(git rev-parse --show-toplevel)"

~~}) {},~~

FLAKE=github:ppenguin/nixenvs

}:

~~let~~

# avoid a "load loop" of direnv when the new fhs env is entered

~~envname =~~ "~~platformio-fhs~~";

# https://github.com/direnv/direnv/issues/992

~~mypython = pkgs.python3.withPackages (ps: with ps; [ platformio~~ ]);

if [ -z "$IN_NIX_SHELL" ]; then

in

use flake $FLAKE\#pio-arduino-fhs

~~(pkgs.buildFHSUserEnv {~~

fi

~~name = envname;~~

~~targetPkgs = pkgs: (with pkgs; [~~

export PRJROOT

~~platformio~~-~~core~~

</syntaxhighlight>This will start a the <code>devShell</code> defined here: https://github.com/ppenguin/nixenvs/blob/main/dev/devshell-pio-arduino-fhs.nix, which includes a working update of the <code>platformio</code> <code>python</code> module for <code>nixpkgs</code>.

~~mypython~~

~~openocd~~

~~]);~~

~~# NixOS~~/~~nixpkgs#263201~~, ~~NixOS~~/~~nixpkgs#262775, NixOS~~/nixpkgs~~#262080~~

~~runScript = "env LD_LIBRARY_PATH= bash";~~

~~}).env~~

</~~syntaxHighlight~~>

== See also ==

@@ Line 3: / Line 3: @@
 == Basic development environment ==
-<syntaxHighlight lang=nix>
+<syntaxhighlight lang="nix">
 { pkgs ? import <nixpkgs> {} }:
 let
 in
    pkgs.mkShell {
-     buildInputs = [
+     buildInputs = with pkgs; [
-       pkgs.platformio
+       platformio
        # optional: needed as a programmer i.e. for esp32
-       # pkgs.avrdude
+       avrdude
      ];
 }
-</syntaxHighlight>
+</syntaxhighlight>
 == NixOS ==
@@ Line 20: / Line 20: @@
 Add the required udev rules.
-<syntaxHighlight lang=nix>
+<syntaxhighlight lang="nix">
 {
-   services.udev.packages = [
+   services.udev.packages = with pkgs; [
-     pkgs.platformio-core
+     platformio-core.udev
-     pkgs.openocd
+     openocd
    ];
 }
-</syntaxHighlight>
+</syntaxhighlight>
 == Use in vscode ==
@@ Line 40: / Line 40: @@
 </syntaxHighlight>
-[https://discourse.nixos.org/t/how-to-use-platformio-with-vscode/15805/3 As of PlatformIO IDE 2.0.0], you will need a shell that allows the extension to run “python -m platformio” ([https://github.com/NixOS/nixpkgs/pull/237313 #237313]):
+[https://discourse.nixos.org/t/how-to-use-platformio-with-vscode/15805/3 As of PlatformIO IDE 2.0.0], <s>you will need a shell that allows the extension to run “python -m platformio” ([https://github.com/NixOS/nixpkgs/pull/237313 #237313])</s>:
+Recently (2024?) simply building an FHS shell with the referred <code>nixpkgs</code> commit doesn't work anymore. The modification is probably incompatible with newer <code>nixpkgs</code>.
-<syntaxHighlight lang=nix>
+There's a quick&dirty fix available as a <code>flake</code> <code>devShell</code>. For usage with <code>direnv</code> (recommended), make an <code>.envrc</code> in your project dir like this:<syntaxhighlight lang="bash">
-{ pkgs ? import (builtins.fetchTarball {
+#!/usr/bin/env bash
-    # NixOS/nixpkgs#237313 = ppenguin:refactor-platformio-fix-ide
-    url = "https://github.com/NixOS/nixpkgs/archive/3592b10a67b518700002f1577e301d73905704fe.tar.gz";
+PRJROOT="$(git rev-parse --show-toplevel)"
-  }) {},
+FLAKE=github:ppenguin/nixenvs
-}:
-let
+# avoid a "load loop" of direnv when the new fhs env is entered
-  envname = "platformio-fhs";
+# https://github.com/direnv/direnv/issues/992
-  mypython = pkgs.python3.withPackages (ps: with ps; [ platformio ]);
+if [ -z "$IN_NIX_SHELL" ]; then
-in
+     use flake $FLAKE\#pio-arduino-fhs
-(pkgs.buildFHSUserEnv {
+fi
-  name = envname;
-  targetPkgs = pkgs: (with pkgs; [
+export PRJROOT
-     platformio-core
+</syntaxhighlight>This will start a the <code>devShell</code> defined here: https://github.com/ppenguin/nixenvs/blob/main/dev/devshell-pio-arduino-fhs.nix, which includes a working update of the <code>platformio</code> <code>python</code> module for <code>nixpkgs</code>.
-    mypython
-    openocd
-  ]);
-  # NixOS/nixpkgs#263201, NixOS/nixpkgs#262775, NixOS/nixpkgs#262080
-  runScript = "env LD_LIBRARY_PATH= bash";
-}).env
-</syntaxHighlight>
 == See also ==