lucasdietrich/caniot-device

Generic firmware for ATmega328p for temperature monitoring, control of IOs and other external devices from a gateway using CAN protocol.

CAN-IoT device (v2)

Disclaimer: This is a still work in progress personal project. I'm having fun reinventing the wheel.

This repository contains the for firmware for the CAN IoT device boards based on the AVR ATmega328P (B) MCU.

It implements the custom CANIOT protocol, which is a simple protocol base on CAN. It enables a Gateway to received telemetry from the device, send generic commands and make essential configuration. Full implementation and documentation of the protocol is available at caniot-lib.

This firmware also runs a custom RTOS, which provides simple features like cooperative multitasking, synchronization primitives, workqueues, low-level drivers and more. Full implementation and documentation of the RTOS is available at AVRTOS.

This firmware does not implement any specific device logic, but allow a gateway to control several types of devices, such as garage door, shutters, heaters and more through the CANIOT protocol.

Required features (TODO)

• I2C bus discovery
• Jitter detection
• Reboot counter
• Implement CANIOT "telemetry on change" for Class 1 Tiny BSP
• Test firmware to impersonate another device/class
• Serial protocol over CAN to send text messages
• 1W: read temperature sensors serial number dynamically
• Attribute for OS monitoring
  • tasks count, max stack usage, irq count, thread switch count, idle time percentage ...
• Implement device inhibit
• Make TCN75 temperature read asynchronous (not in telemetry handler)
• Remove __PACKED structures from buffer union in caniot_frame to make code portable

Boards

Following boards are supported:

• V1 (documentation): First prototype (used for garage door controller and outdoor alarm controller)
• Tiny (documentation): Second prototype (used for heating controller and shutters controller)

Board	MCU	Controllable pins	Devices/Drivers support	CANIOT Class
V1	ATmega328P(B)	8	TCN75 DS18S20	CLASS0
Tiny rev A schematic	ATmega328P(B)	19	TCN75(A) DS18S20 PCF8574(A)	CLASS1
Tiny rev B	ATmega328P(B)	19	TCN75(A) DS18S20 PCF8574(A)	CLASS1

Applications:

• Garage Door Controller
• Outdoor Alarm Controller
• Heating Controller
• Shutters Controller

All features

• Boards
  • v1
  • Tiny
• MCU Support
  • ATmega328P
  • ATmega328PB
• Communication
  • CAN
  • CANIOT protocol
• Device support
  • TCN75 (A) (I2C)
  • DS18S20 (one wire)
  • PCF8574 (A) (I2C)
• More high-level features
  • GPIO Pulse support
  • Heaters
  • Shutters
  • Grid power presence detection

Project structure

├── docs : documentation
├── include
├── lib : external libraries
│   ├── AVRTOS : Custom RTOS for AVR MCUs
│   ├── caniot-lib : Custom CAN application protocol
├── pics
├── res : Ressources (board schematics, ...)
├── platformio.ini : PlatformIO configuration
├── readme.md : This file
├── scripts
└── src : Source code
    ├── bsp : Board support package for supported boards (v1, tiny, ...)
    ├── class : Code specific to a specific CANIOT class (see CANIOT protocol documentation)
    ├── devices : Drivers for supported devices (TCN75, DS18S20, heater, shutter, ...)
    ├── nodes : Specific code to achieve device role (garage door, heater, ...)

Build the firmware

PlatformIO for VSCode is required to build the firmware. Then simply select the application you want to build and press the build button.

Bootloader

Minicore bootloader is required.

Flash the firmware

Flash with PlatformIO or avrdude.

Monitor

With pyserial miniterm: python3 -m serial.tools.miniterm /dev/ttyACM0 500000. Exit with Ctrl + T then Q

Or screen: screen /dev/ttyACM0 500000. Exit screen with shortcuts : Ctrl + A and Ctrl + \ meaning (AltGr + 8), then y.

---

Devices

• Garage Door Controller
• Outdoor Alarm Controller
• Heating Controller
• Shutters Controller

Expected result with Outdoor Alarm Controller (outdated)

Logs

ROM = 28 bc 49 9c 32 20 1 83: DS18B20
===== k_thread =====
C 0x045C READY   C ____ : SP 21/110:0x016D
A 0x0470 READY   C ____ : SP 21/160:0x020D
W 0x0484 READY   C ____ : SP 21/128:0x02D1
M 0x0498 READY   C ____ : SP 0/250:0x06D4
I 0x04AC READY   P ____ : SP 21/59:0x0248
name    = AlarmController
cls/dev = 0/3
version = c8

00:00:00 [0.026 s] : [ c5 ] Telemetry Response [24] 0x18 (cls=C0 sid=D3) : ep-0 / 00 00 f4 01 00 00 46 00 
[C] CANARIES until @0133 [found 50], MAX usage = 59 / 109 + 1 (sentinel) 
[A] CANARIES until @01EE [found 127], MAX usage = 32 / 159 + 1 (sentinel)
[W] CANARIES until @0293 [found 64], MAX usage = 63 / 127 + 1 (sentinel)
[M] CANARIES until @0620 [found 68], MAX usage = 181 / 249 + 1 (sentinel)
[I] CANARIES until @0220 [found 17], MAX usage = 41 / 58 + 1 (sentinel)
00:00:16 [16.450 s] : [ c0 ] Command Query [24] 0x18 (cls=C0 sid=D3) : ep-0 / 00 10 00 00 00 00 00 00
00:00:16 [16.452 s] : alarm: inactive -> observing
00:00:16 [16.454 s] : [ c5 ] Telemetry Response [24] 0x18 (cls=C0 sid=D3) : ep-0 / 04 00 f4 01 00 00 7d 00
00:00:21 [21.571 s] : [ c0 ] Command Query [24] 0x18 (cls=C0 sid=D3) : ep-0 / 00 01 00 00 00 00 00 00
00:00:21 [21.574 s] : [ c5 ] Telemetry Response [24] 0x18 (cls=C0 sid=D3) : ep-0 / 05 00 f4 01 00 00 7d 00
00:00:22 [22.430 s] : [ c0 ] Command Query [24] 0x18 (cls=C0 sid=D3) : ep-0 / 00 04 00 00 00 00 00 00
00:00:22 [22.439 s] : [ c5 ] Telemetry Response [24] 0x18 (cls=C0 sid=D3) : ep-0 / 07 00 f4 01 00 00 7d 00
00:00:25 [25.043 s] : [ c0 ] Command Query [24] 0x18 (cls=C0 sid=D3) : ep-0 / 00 00 00 00 00 00 00 00
00:00:25 [25.046 s] : [ c5 ] Telemetry Response [24] 0x18 (cls=C0 sid=D3) : ep-0 / 07 00 f4 01 00 00 7d 00
00:00:26 [26.184 s] : [ c0 ] Command Query [24] 0x18 (cls=C0 sid=D3) : ep-0 / 00 00 00 00 00 00 00 00
00:00:26 [26.187 s] : [ c5 ] Telemetry Response [24] 0x18 (cls=C0 sid=D3) : ep-0 / 07 00 f4 01 00 00 7d 00
00:00:27 [27.013 s] : [ c0 ] Command Query [24] 0x18 (cls=C0 sid=D3) : ep-0 / 00 00 00 00 00 00 00 00
00:00:27 [27.016 s] : [ c5 ] Telemetry Response [24] 0x18 (cls=C0 sid=D3) : ep-0 / 07 00 f4 01 00 00 7d 00
00:00:28 [28.133 s] : [ c0 ] Command Query [24] 0x18 (cls=C0 sid=D3) : ep-0 / 00 00 00 00 00 00 00 00
00:00:28 [28.136 s] : [ c5 ] Telemetry Response [24] 0x18 (cls=C0 sid=D3) : ep-0 / 07 00 f4 01 00 00 7d 00
[C] CANARIES until @0132 [found 49], MAX usage = 60 / 109 + 1 (sentinel)
[A] CANARIES until @0194 [found 37], MAX usage = 122 / 159 + 1 (sentinel)
[W] CANARIES until @0293 [found 64], MAX usage = 63 / 127 + 1 (sentinel)
[M] CANARIES until @061D [found 65], MAX usage = 184 / 249 + 1 (sentinel)
[I] CANARIES until @0220 [found 17], MAX usage = 41 / 58 + 1 (sentinel)

Capability mask

bit(s)	name	description
0	watchdog support	yes/no
1	dfu support	yes/no
2	release	yes/no
3:4	microcontroller	0: atmega328p, 1: atmega328pb
5:6	DS18B20 support	0: no, 1,2,3: DS max count
7:8	TCN75 support	0: no, 1: TCN75, 2: TCN75A
9:10	heaters support	0: no, 1,2,3: max count
11:12	shutters support	0: no, 1,2,3: max count
13:14	relays support	0: no, 1,2,3: max count
15:16	optocoupler support	0: no, 1,2,3: max count

Devops

Build docker image:

docker build -t devops/fedora-pio-toolchain -f scripts/Dockerfile .

Run docker image:

docker run --entrypoint /bin/bash -it devops/fedora-pio-toolchain

Run pio within the docker image:

docker run -it devops/fedora-pio-toolchain 

Documentation

Create python virtual environment:

python3 -m venv venv

Install mkdocs:

pip install mkdocs-material

Run mkdocs:

mkdocs serve

Ressources (to cleanup)

• https://docs.arduino.cc/built-in-examples/arduino-isp/ArduinoISP
• https://arduino.stackexchange.com/questions/36071/how-does-avrdude-burn-a-bootloader-much-quicker-than-the-arduino-ide
• https://www.avrfreaks.net/forum/cannot-connect-avrdude-mega2560
• https://github.com/MCUdude/MiniCore
• https://github.com/MCUdude/MiniCore/blob/master/PlatformIO.md
• https://github.com/MCUdude/MiniCore/tree/master/avr/bootloaders/optiboot_flash/bootloaders/atmega328pb/16000000L
• https://community.platformio.org/t/upload-and-debug-for-atmega328p-with-atmel-ice/18796
• https://community.platformio.org/t/burn-bootloader-for-a-custom-atmega328p-board/22587
• https://community.platformio.org/t/minicore-atmega328p/9042
• https://docs.platformio.org/en/latest/frameworks/arduino.html#minicore-mightycore-megacore
• https://www.avrfreaks.net/forum/watchdog-reset-or-any-other-software-reset
• https://www.avrfreaks.net/forum/software-reset-6
• https://www.avrfreaks.net/forum/how-use-avr-watchdog
• https://www.avrfreaks.net/comment/178013#comment-178013