Skip to content

Commit f750bf6

Browse files
committed
update README
1 parent 5b8fb1f commit f750bf6

File tree

3 files changed

+96
-85
lines changed

3 files changed

+96
-85
lines changed

README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,38 @@ This will install all dependencies for firmware and documentation development in
1414

1515
The Datenzwerg firmware is based on [esphome](https://esphome.io/) which gets installed as dependency when running the above setup command.
1616

17+
> [!NOTE]
18+
>
19+
> The firmware currently requires ESPHOME 2025.7.4, as set in the `requirements.txt`. Other versions might cause errors.
20+
1721
To flash your own Datenzwerg, navigate to the `firmware` directory, then
1822

19-
1. Copy `secrets-template.yaml` to `secrets.yaml` and fill in your WiFi and InfluxDB2 credentials.
20-
2. Run `esphome -s name <gnome> run datenzwerg.yaml` to compile and flash the firmware for your gnome named `<gnome>`.
23+
1. Copy `secrets-template.yaml` to `packages/secrets.yaml` and fill in your WiFi and InfluxDB2 credentials.
24+
2. Run `esphome -s name <gnome> run datenzwerg-{psu|battery|sensortest}.yaml` to compile and flash the firmware for your gnome named `<gnome>`.
25+
- `psu`: firmware optimized for deployment with a power supply; includes uptime, CO2 sensor and MQTT
26+
- `battery`: firmware optimized for deployment with a battery; disables uptime, CO2 sensor and MQTT but enables deepsleep
27+
- `sensortest`: firmware for testing all sensors; enables a webserver to check tracking
2128

2229
### Models
2330

2431
The gnome model files are based on https://www.printables.com/model/260908-garden-gnome by [Sci3D](https://www.printables.com/@Sci3D), released under CC-BY.
2532

2633
In the `models` directory, you will find the following files:
2734

28-
- `datenzwerg_40p_1.2mm.blend`: Main design file, edit with [Blender](https://blender.org)
29-
- `datenzwerg_40p_1.2mm_top.stl`: Upper body, electronics compartment
30-
- `datenzwerg_40p_1.2mm_bottom.stl`: Lower body, feet, mount point
31-
- `datenzwerg_40p_1.2mm_bottom_poe.stl`: Lower body, feet, mount point, PoE versionA
32-
33-
Additionally you'll find some SVGs for laser cutting foam inserts for L-Boxx cases to store the Datenzwerge in, and some labels and logos.
35+
- **Gnome body**
36+
- `datenzwerg_40p_1.2mm.blend`: Main design file, edit with [Blender](https://blender.org)
37+
- `datenzwerg_40p_1.2mm_top.stl`: Upper body, electronics compartment
38+
- `datenzwerg_40p_1.2mm_bottom.stl`: Lower body, feet, mount point
39+
- `datenzwerg_40p_1.2mm_bottom_poe.stl`: Lower body, feet, mount point, PoE versionA
40+
- `datenzwerg_logo.svg`: Logo in SVG format
41+
- **Gnome mounting**
42+
- `ground-plate-bottom.FCStd`: Ground plate design file, edit with [FreeCAD](https://freecad.org)
43+
- `ground-plate-bottom.stl`: Ground plate bottom part
44+
- **Gnome transport L-Boxx**
45+
- `l-boxx-136-inlay.FCStd`: L-Boxx Inlay design file, edit with [FreeCAD](https://freecad.org)
46+
- `label-l-boxx.svg`: Label for the L-Boxx
47+
- **Various labels**
48+
- `label-2024.svg`: Gnome label for 37c3
3449

3550
### Documentation
3651

models/datenzwerg_logo.svg

Lines changed: 73 additions & 77 deletions
Loading
File renamed without changes.

0 commit comments

Comments
 (0)