From 48dc17b82566cce86aa5d1b6cc5072c7af5a6ea7 Mon Sep 17 00:00:00 2001 From: Jan Mrna Date: Thu, 9 Nov 2023 21:47:23 +0100 Subject: [PATCH] Updated README --- README.md | 45 +++++++++++++++++++++++++++++++++------------ 1 file changed, 33 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 83bb899..ace4f4a 100644 --- a/README.md +++ b/README.md @@ -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 @@ -25,12 +20,32 @@ This sensor which is part of wider family of Veles Smart Household sensors. * Input voltage: 5 - 30 V DC -![IAQ wired sensor render](PCB/Project_Outputs/3D_MODEL/Images/iaq_wired_sensor.png) +## Project files +* [Hardware](PCB) + * Schematic and PCB ([KiCAD](https://www.kicad.org/) project) in [`PCB/iaq_wired_sensor.kicad_pro`](PCB/Project_Outputs/iaq_wired_sensor.kicad_pro) + * PCB step model in [`PCB/3D_MODEL/iaq_wired_sensor.step`](PCB/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 + +IAQ wired sensor renderFront view of the sensor ## 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 +65,15 @@ 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 ### Input Registers