v3_firmware/README.md

# ATTNode v3 Firmware

## Documentation

**The full documentation for firmware options, payload decoders and programming can be found at [attno.de](https://www.attno.de/21-firmware-v3)**

## Configuration and Programming

This is the code repository for ATTNode v3 compatible firmware. At the moment it supports LoRa communication using OTAA and a BME280 or SHT21 sensor, as well as deep sleep between measurements.

The firmware is developed using [PlatformIO](https://platformio.org/). At least version 5.1.0 is needed for ATTiny3216 support.

To set the fuses for clock speed, BOD levels etc., use the "Set Fuses" operation in PlatformIO. This has to be done once for a "fresh" Node or when the Board Config in platformio.ini was changed. Afterwards it is enough to use the normal "Upload" function for Code or config.h changes.

Before programming a node, copy src/config.h.example to src/config.h and set the used sensor, LoRaWAN keys and other options as needed.

Programming is done using a [MicroUPDI Programmer](https://github.com/MCUdude/microUPDI), settings in platformio.ini are set to use it. For other pogrammer options see the PlatformIO Documentation

## Payload Decoder

You need to specify a Payload Decoder fitting for your configured Sensors for a Node. See payload/index.html in this repository. Open it in your Browser of Choice and select the enabled sensors. It will generate the Payload Decoder fitting for the choosen Sensors. You can also use the Online Version at [attno.de](https://www.attno.de/payload-generator)

## Configuring via Downlink

It is possible to change the sending interval via Downlink-Packets at runtime. Downlinks for setting the transmit interval have to be sent on port 1. The time between Transmits is specified in minutes (or more exactly, 64 Second intervals) and as a 2 byte value, which will be interpreted as an uint. So for example 0x0001 means 1 Minute, 0x0002 means 2 Minutes and so on. Sending 0xFFFF resets the value to the compiled in default.

Sending an arbitrary value on port 2 will activate the calibration sequence for sensors that support it (like some of the CO2-Sensors).

## Acknowledgements

Parts of this code where kindly provided by [@shempe](https://twitter.com/shempe)
Convert Firmware to PlatformIO Project 2021-02-01 17:29:05 +00:00			`# ATTNode v3 Firmware`
Initial Checkin 2020-11-26 15:56:36 +00:00
Add Link to Firmware Documentation 2020-12-28 18:08:02 +00:00			`## Documentation`

			`The full documentation for firmware options, payload decoders and programming can be found at [attno.de](https://www.attno.de/21-firmware-v3)`

Use LMIC and OTAA, Implement BME280 support 2020-12-01 20:04:27 +00:00			`## Configuration and Programming`
Initial Checkin 2020-11-26 15:56:36 +00:00
Adapted Readme 2021-02-01 17:32:24 +00:00			`This is the code repository for ATTNode v3 compatible firmware. At the moment it supports LoRa communication using OTAA and a BME280 or SHT21 sensor, as well as deep sleep between measurements.`
Use LMIC and OTAA, Implement BME280 support 2020-12-01 20:04:27 +00:00
Adapted Readme 2021-02-01 17:32:24 +00:00			`The firmware is developed using [PlatformIO](https://platformio.org/). At least version 5.1.0 is needed for ATTiny3216 support.`
Use LMIC and OTAA, Implement BME280 support 2020-12-01 20:04:27 +00:00
Adapted Readme 2021-02-01 17:32:24 +00:00			`To set the fuses for clock speed, BOD levels etc., use the "Set Fuses" operation in PlatformIO. This has to be done once for a "fresh" Node or when the Board Config in platformio.ini was changed. Afterwards it is enough to use the normal "Upload" function for Code or config.h changes.`
Use LMIC and OTAA, Implement BME280 support 2020-12-01 20:04:27 +00:00
Adapted Readme 2021-02-01 17:32:24 +00:00			`Before programming a node, copy src/config.h.example to src/config.h and set the used sensor, LoRaWAN keys and other options as needed.`
Use LMIC and OTAA, Implement BME280 support 2020-12-01 20:04:27 +00:00
Convert Firmware to PlatformIO Project 2021-02-01 17:29:05 +00:00			`Programming is done using a [MicroUPDI Programmer](https://github.com/MCUdude/microUPDI), settings in platformio.ini are set to use it. For other pogrammer options see the PlatformIO Documentation`
Use LMIC and OTAA, Implement BME280 support 2020-12-01 20:04:27 +00:00
Add SCD30 to config.h.example, README 2021-03-31 14:41:36 +00:00			`## Payload Decoder`
Added README Section for Multisensor Mode Added More Comments Cleanup and Formatting 2021-03-18 16:57:00 +00:00
Use Correct URL for Payload Decoder Generator 2021-04-10 16:11:01 +00:00			`You need to specify a Payload Decoder fitting for your configured Sensors for a Node. See payload/index.html in this repository. Open it in your Browser of Choice and select the enabled sensors. It will generate the Payload Decoder fitting for the choosen Sensors. You can also use the Online Version at [attno.de](https://www.attno.de/payload-generator)`
Added README Section for Multisensor Mode Added More Comments Cleanup and Formatting 2021-03-18 16:57:00 +00:00
Add Serial Debug Functions, Configuring Interval via Downlink 2020-12-20 10:48:23 +00:00			`## Configuring via Downlink`

Add Remote Calibration to Readme 2021-04-06 18:09:15 +00:00			`It is possible to change the sending interval via Downlink-Packets at runtime. Downlinks for setting the transmit interval have to be sent on port 1. The time between Transmits is specified in minutes (or more exactly, 64 Second intervals) and as a 2 byte value, which will be interpreted as an uint. So for example 0x0001 means 1 Minute, 0x0002 means 2 Minutes and so on. Sending 0xFFFF resets the value to the compiled in default.`

			`Sending an arbitrary value on port 2 will activate the calibration sequence for sensors that support it (like some of the CO2-Sensors).`
Add Serial Debug Functions, Configuring Interval via Downlink 2020-12-20 10:48:23 +00:00
Use LMIC and OTAA, Implement BME280 support 2020-12-01 20:04:27 +00:00			`## Acknowledgements`

			`Parts of this code where kindly provided by [@shempe](https://twitter.com/shempe)`