Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rbaron/b-parasite

🌱💧 An open source DIY soil moisture sensor
https://github.com/rbaron/b-parasite

ble bluetooth-low-energy iot nrf52 sensor soil-moisture soil-moisture-sensor

Last synced: about 1 month ago
JSON representation

🌱💧 An open source DIY soil moisture sensor

Host: GitHub
URL: https://github.com/rbaron/b-parasite
Owner: rbaron
Created: 2021-02-10T21:56:33.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-11-08T17:59:11.000Z (about 2 months ago)
Last Synced: 2024-11-08T18:42:18.802Z (about 2 months ago)
Topics: ble, bluetooth-low-energy, iot, nrf52, sensor, soil-moisture, soil-moisture-sensor
Language: C
Homepage:
Size: 28.2 MB
Stars: 1,945
Watchers: 43
Forks: 151
Open Issues: 35
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        [![b-parasite firmware build](https://github.com/rbaron/b-parasite/actions/workflows/b-parasite.yml/badge.svg?branch=main)](https://github.com/rbaron/b-parasite/actions/workflows/b-parasite.yml)

# b-parasite



  



b-parasite is an open source soil moisture and ambient temperature/humidity/light sensor.

# Features

* Capacitive Soil moisture sensor - see [this blog post](https://rbaron.net/blog/2021/04/05/How-capacitive-soil-moisture-sensors-work.html), [this Twitter thread](https://twitter.com/rbaron_/status/1367182806368071685), and [this post](https://wemakethings.net/2012/09/26/capacitance_measurement/) for nice resources on how they work

* Air temperature and humidity sensor using a [Sensirion's SHTC3](https://www.sensirion.com/en/environmental-sensors/humidity-sensors/digital-humidity-sensor-shtc3-our-new-standard-for-consumer-electronics/)

* Light sensor using an [ALS-PT19](https://en.everlight.com/wp-content/plugins/ItemRelationship/product_files/pdf/ALS-PT19-315C-L177-TR8_V8.pdf) phototransistor

* Powered by a common CR2032 coin cell, potentially for over two years

* Support for [nRF52840](https://www.nordicsemi.com/products/nrf52840) and [nRF52833](https://www.nordicsemi.com/products/nrf52833) modules

* Open hardware and open source design

# Software

This repository also hosts a few different firmware samples for b-parasite.

|Sample|Description|Extra Documentation|

|---|---|---|

|[samples/ble](./code/nrf-connect/samples/ble)|This is the most battle-tested and useful firmware. It periodically reads all sensors and broadcast them via Bluetooth Low Energy (BLE). It works with [Home Assistant](https://www.home-assistant.io/) + [BTHome](https://bthome.io/) out of the box. |[Docs](./code/nrf-connect/samples/ble/README.md)|

|[samples/zigbee](./code/nrf-connect/samples/zigbee)| An experimental/educational/exploratory basic Zigbee sample built on [nRF Connect + ZBOSS](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/ug_zigbee.html). It integrates with [Home Assistant](https://www.home-assistant.io/) via [ZHA](https://www.home-assistant.io/integrations/zha) or [Zigbee2MQTT](https://www.zigbee2mqtt.io/). |[Docs](./code/nrf-connect/samples/zigbee/README.md)|

|[samples/blinky](./code/nrf-connect/samples/blinky)| The classic "Hello, world" |-|

|[samples/soil_read_loop](./code/nrf-connect/samples/soil_read_loop)| Reads the soil moisture sensor on a loop. Useful for experimenting and calibrating the sensor. |-|

|[samples/input](./code/nrf-connect/samples/input)| Handles button presses. Useful for power profiling GPIO interrupts and testing debouncing for push switches on [boards that have them](https://github.com/rbaron/b-parasite/wiki/Hardware-Versions). |-|

# Documentation

Information about how to order, assemble, build the samples, protect the sensor and flash the firmware is on [the Wiki](https://github.com/rbaron/b-parasite/wiki).

# Repository Organization

* [code/nrf-connect/](./code/nrf-connect/) - Common library and samples, built with Nordic's [nRF Connect SDK](https://www.nordicsemi.com/Products/Development-software/nrf-connect-sdk).

* [kicad/](./kicad/) - KiCad schematic, layout and fabrication files for the printed circuit board (PCB)

* [data/](data/) - data for testing and sensor calibration

* [bridge/](bridge/) - an [ESPHome](https://github.com/esphome/esphome)-based BLE-MQTT bridge

* [case/](case/) - a 3D printable case



  



# Case



  



We have three different 3D-printable cases:

1. Original snap-on case - [case/Top.stl](./case/Top.stl), [case/Bottom.stl](./case/Bottom.stl)

2. High airflow - [case/b_parasite_case_high_airflow.stl](./case/b_parasite_case_high_airflow.stl)

3. Mushroom-style - available on [Printables](https://www.printables.com/model/456571-mushroomcap-for-b-parasite-soil-moisture-sensor)

4. b-parasite Hat - available on [Printables](https://www.printables.com/model/901220-waterproof-case-for-b-parasite-soil-moisture-air-s)

# Accessories

Designs and hardware to help you, when building your own:

1. Desk holder for b-parasites [Printables](https://www.printables.com/de/model/566974-b-parasite-holder)

# License

The hardware and associated design files are released under the [Creative Commons CC BY-SA 4.0 license](https://creativecommons.org/licenses/by-sa/4.0/).

The code is released under the [MIT license](https://opensource.org/licenses/MIT).