Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Rogger authored Aug 29, 2024
1 parent 2e92160 commit 2407da5
Showing 1 changed file with 3 additions and 12 deletions.
15 changes: 3 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Schneggi sensor 🐌
A low-power ZigBee sensor integrated with HomeAssistant for monitoring temperature, humidity, and CO2 levels.
A low-power ZigBee sensor integrated with HomeAssistant for monitoring temperature, humidity, and CO2.

## Design Goals
- High accuracy temperature and humidity measurements ([Sensirion SHTC3](https://www.sensirion.com/products/catalog/SHTC3/))
Expand All @@ -18,23 +18,14 @@ The PCB was designed with KiCad 7 and manufactured/assembled with JLCPCB. All re
![base](https://github.com/user-attachments/assets/ae48fca6-d7ca-4260-b0ca-0d7fdca1a1e8)
![co2](https://github.com/user-attachments/assets/a420414e-1857-45f5-8971-0bba9cf12d0e)

## Case
A 3D printable case was generated with the help of [Ultimate Box Maker](https://github.com/jbebel/Ultimate-Box-Maker).

![Ultimate_Box](https://github.com/Rogger/schneggi-sensor/assets/371835/782dbbfe-b442-4105-b787-0a193e914e4e)

## HomeAssistant
Works out of the box

![Screenshot from 2023-11-21 21-22-59](https://github.com/Rogger/schneggi-sensor/assets/371835/cefebd48-2896-4cb5-bfa6-d6ba029c3226)

![Screenshot from 2023-11-21 21-27-04](https://github.com/Rogger/schneggi-sensor/assets/371835/61f52585-6c13-4973-a659-87bb132f250d)
![image](https://github.com/user-attachments/assets/fe9de769-8348-4b40-8632-f8fcfae44b9a)

## How to build?
- Install VSCode + nRF plugins.
- Install VSCode + nRF plugins
- Install nRF SDK and toolchain 2.5.0
- Add a build configuration with custom board `adafruit_feather_nrf52840`
- You can program the board with the nRF52840 DK, the following wiring was used https://devzone.nordicsemi.com/f/nordic-q-a/84893/programming-a-custom-board-with-an-nrf52840-dev-kit. Additionally the pin RESET is connected, for automatic board reset.

## Resources
- The PCB design was inspired by [Getting Started With nRF52 MCU in a PCB](https://resources.altium.com/p/getting-started-nrf52-mcu-pcb#getting-started-schematics)
Expand Down

0 comments on commit 2407da5

Please sign in to comment.