diff --git a/NucuCar.Sensors/Readme.md b/NucuCar.Sensors/Readme.md index 2333a98..46ecf79 100644 --- a/NucuCar.Sensors/Readme.md +++ b/NucuCar.Sensors/Readme.md @@ -1,17 +1,15 @@ -This application will read sensors data periodically, -provide access to it via gRPC and publish telemetry to the cloud. +# Introduction -## Installation How-To +This module will read sensors data periodically and +provide access to it via gRPC, while optionally publishing telemetry data into the cloud. -1. Build the module and target the Raspberry Pi. -2. Copy the files over to the Raspberry Pi. -3. Modify `appsettings.json` to fit your needs. -4. Install the hardware. +For installing see instructions from the Readme.md file located at the root directory. -### Wiring +# Wiring -You may download the Fritzing diagram from `Docs/fritzing/nucucar.sensors.fzz` -in order to play with it. +_You may download the Fritzing diagrams from `Docs/fritzing/` in order to play with them._ + +Wire your sensor according to the following diagram: ![alt text](../Docs/images/nucucar.sensors_bb.jpg) @@ -20,13 +18,14 @@ in order to play with it. Connect the BME680 sensor to the I2C bus 1 (I2C.1) of the Raspberry Pi. The address ` 0x76` will be used to communicate with the sensor. - -5\. Run the application. +Make sure I2C is enabled. Use `raspi-config`. -### Environment Sensor +# Sensors -Worker service for the [BME680](https://www.bosch-sensortec.com/bst/products/all_products/bme680) environmental sensor from Bosh. +#### Environment Sensor + +We use [BME680](https://www.bosch-sensortec.com/bst/products/all_products/bme680) environmental sensor from Bosh. Sensor capabilities: