Skip to content

Commit 5bb92ab

Browse files
zakoverflowzfields
andcommitted
fix: Notestation docker-compose.yaml (blues#160)
* docs: add Notestation setup and usage documentation; fix docker-compose.yaml for v3.8 compatibility --------- Co-authored-by: Zachary J. Fields <zachary_fields@yahoo.com>
1 parent 1bd6be0 commit 5bb92ab

1 file changed

Lines changed: 56 additions & 2 deletions

File tree

README.md

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,64 @@ Before running an example, you will need to set the Product Identifier, either
107107
in code or on your connected Notecard. Steps on how to do this can be found at
108108
[https://dev.blues.io/tools-and-sdks/samples/product-uid](https://dev.blues.io/tools-and-sdks/samples/product-uid).
109109

110-
## Notestation Usage
110+
## Notestation Setup and Usage
111111

112112
To gain access to the Tailscale VPN for Notestation, create a `.env` file based on `.env.example` in the `.devcontainer/notestation/` folder. Replace the placeholder TS_AUTHKEY with your actual Tailscale authentication key. Treat the .env file as sensitive and do not commit it to version control or share it publicly. This will set up the necessary environment variables for VPN access.
113113

114+
### Launching the Dev Container
115+
116+
Run:
117+
118+
```
119+
devcontainer up --config .devcontainer/notestation/devcontainer.json --workspace-folder .
120+
```
121+
122+
Verify containers are running:
123+
124+
```
125+
docker ps -a --filter "name=note-arduino"
126+
```
127+
128+
Exec into the dev container:
129+
130+
```
131+
docker exec -it note-arduino_devcontainer bash
132+
```
133+
134+
Inside the container, check Notestation:
135+
136+
```
137+
pipenv run notestation --version
138+
pipenv run notestation client list
139+
```
140+
141+
### Compiling and Flashing Examples
142+
143+
Inside the dev container:
144+
145+
1. Navigate to workspace: `cd /workspace/examples/Example6_SensorTutorial`
146+
147+
2. Compile for target (e.g., SWAN_R5 or CYGNET fallback):
148+
149+
```
150+
arduino-cli compile --fqbn blues:swan:swan_r5 . # For SWAN_R5
151+
arduino-cli compile --fqbn blues:swan:cygnet . # For CYGNET
152+
```
153+
154+
3. Flash to Notestation (e.g., barcelona-notestation-2 for CYGNET):
155+
156+
```
157+
pipenv run notestation flash --client barcelona-notestation-2 --tag mcu_cygnet --bin Example6_SensorTutorial.ino.bin
158+
```
159+
160+
If primary station offline, fallback as needed.
161+
162+
### Troubleshooting
163+
164+
- Tailscale errors: Verify TS_AUTHKEY, restart containers.
165+
- Client not found: Check `client list --all`; use online alternatives.
166+
- Merge conflicts on rebase: Resolve by keeping custom sections.
167+
114168
## Contributing
115169

116170
We love issues, fixes, and pull requests from everyone. Please run the
@@ -318,4 +372,4 @@ Copyright (c) 2019 Blues Inc. Released under the MIT license. See
318372
[note-python]: https://github.com/blues/note-python
319373
[archive]: https://github.com/blues/note-arduino/archive/master.zip
320374
[code of conduct]: https://blues.github.io/opensource/code-of-conduct
321-
[notehub]: https://notehub.io
375+
[notehub]: https://notehub.io

0 commit comments

Comments
 (0)