veles_labs/iaq_sensor_wired
2
0
Fork 0
Code Issues 6 Pull Requests Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
Jan Mrna 2023-11-09 22:01:41 +01:00
parent ac82c8a45d
commit 489389ed8f
1 changed files with 44 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@ -1,12 +1,6 @@
# Indoor Air Quality sensor (wired version)
# Indoor Air Quality sensor IAQ01
This repository contains all CAD files needed for making a Veles IAQ01 wired sensor:
* Hardware: KiCAD project (schematic, PCB and exported Gerbers)
* Firmware: STM32 IDE project
* Enclosure: FreeCAD project
This sensor which is part of wider family of Veles Smart Household sensors.
This repository contains all CAD files needed for making a Veles IAQ01 wired sensor, part of a family of [Veles Smart Household](#veles-smart-household) sensors.
## Basic properties
@ -16,6 +10,7 @@ This sensor which is part of wider family of Veles Smart Household sensors.
* Temperature
* Relative humidity
* Volatile Organic Compounds (VOC)
* PM (particulate matter) [optional extension]
### Connectivity
@ -23,14 +18,42 @@ This sensor which is part of wider family of Veles Smart Household sensors.
### Power requirements
* Input voltage: 5 - 30 V DC
* Input voltage: 5 - 30 V DC
![IAQ wired sensor render](PCB/Project_Outputs/3D_MODEL/Images/iaq_wired_sensor.png)
### Status indication
Sensor has a RGB LED, which shows current air quality status on a continuos scale from red to green. Limits for this full green / full red are user adjustable. Indication can be also configured to non-continuos "semaphore" mode, using only 3 colors (green / yellow / red). Intensity of the LED can be set (or the LED can be disabled entirely).
## Where to get these sensors?
We hope to be able to be to offer you these sensors in one way or another (fully assembled or some kits with PCBs and components). In the meantime, you can build one yourselves! You will need a bit of experience with PCB ordering, soldering, and flashing the firmware on STM32. Don't worry though, none of these require deep expertise. Also a 3D printer will come in handy, if you want some of those pretty enclosures. We suggest using white PETG - this makes the LED shine nicely through the front of the enclosure.
## Project files
* [Hardware](PCB)
* Schematic and PCB ([KiCAD](https://www.kicad.org/) project) in [`PCB/iaq_wired_sensor.kicad_pro`](PCB/iaq_wired_sensor.kicad_pro)
* PCB step model in [`PCB/Project_Outputs/3D_MODEL/iaq_wired_sensor.step`](PCB/Project_Outputs/3D_MODEL/iaq_wired_sensor.step)
* Gerbers for PCB manufacturing in [`PCB/Project_Outputs/GERBERS`](PCB/Project_Outputs/GERBERS)
* Schematic exported as PDF in [`PCB/Project_Outputs/Schematic/iaq_wired_sensor.pdf`](PCB/Project_Outputs/Schematic/iaq_wired_sensor.pdf)
* Interactive HTML BOM file in [`PCB/Project_Outputs/iBOM/iaq_wired_sensor_rev1_ibom.html`](PCB/Project_Outputs/iBOM/iaq_wired_sensor_rev1_ibom.html)
* [Firmware](fw)
* This is a [STM32Cube IDE](https://www.st.com/en/development-tools/stm32cubeide.html) project
* Uses a number of git submodules - clone this repo with `--recursive` or use `git submodule update --init` to get them
* [Enclosure](Enclosure)
* [FreeCAD](https://www.freecad.org/) project in [`Enclosure/IAQ_Sensor_Enclosure.FCStd`](Enclosure/IAQ_Sensor_Enclosure.FCStd)
* STL files in [`Enclosure/STLs`](Enclosure/STLs)
* Printing tested on Prusa Mk2S
* [Documentation](Documentation)
* Datasheet in [`Documentation/Datasheet/IAQ_Wired_Sensor_Datasheet.pdf`](Documentation/Datasheet/IAQ_Wired_Sensor_Datasheet.pdf)
* Product flyer in [`Documentation/Product_Flyer/wired_iaw_sensor_flyer_rev1.pdf`](Documentation/Product_Flyer/wired_iaw_sensor_flyer_rev1.pdf)
## Images
<img src="PCB/Project_Outputs/3D_MODEL/Images/iaq_wired_sensor.png" alt="IAQ wired sensor render" width="25%" height="auto"><img src="Documentation/Datasheet/fig/iaq_wired_sensor.png" alt="Front view of the sensor" width="25%" height="auto">
## Veles Smart Household
Goal of this project is to create FOSS hardware and software platform for measuring various quantities, not only related to indoor air quality:
This sensor is part of Veles Smart Household. Goal of this project is to create open hardware and software platform for measuring various quantities, not only related to indoor air quality:
* temperature
* humidity
@ -50,9 +73,17 @@ Sensors are connected either via RS-485 Modbus or wirelessly to central unit. Wi
### Other Smart Household repositories
WIP
* [RHT wired sensor](https://gitea.veleslabs.org/veles_labs/rht_sensor_wired)
* [Python package](https://gitea.veleslabs.org/veles_labs/pyveles) for sensor readout and visualization (work in progress)
* Can be installed using `pip install veles`
## MODBUS Registers
## Further reading
If you need more data, check out the [datasheet](Documentation/Datasheet/IAQ_Wired_Sensor_Datasheet.pdf).
## Modbus register cheatsheet
If you're here just to see the addresses for the readout, here they are:
### Input Registers