home-climate-control / hcc-esp32 Goto Github PK

As an application developer and an infrastructure engineer, I want my application to be able to provide NTP sourced timestamps so that MQTT consumers can observe correct event time.

Acceptance criteria: Actual time retrieved from NTP and available for information producers within application.

As an application developer, I want to be able to order A4988 chip to fall asleep, so that I can conserve energy.

Acceptance criteria: SLP signal passed to A4988 and works as documented.

As a Home Climate Control user, I want all edge devices to have consistent behavior so that I don't have to remember which is which and stay amazed at subtle differences between them.

Acceptance criteria: onboard LED blink pattern is the same as hcc-esp8266 provides:

• LED stays on while connecting to WiFi and MQTT broker;
• LED turns on for 5ms before 1-Wire bus poll, and for 5ms after.

(depends on #4)

As an application developer, I want to publish 1-Wire sensor samples to MQTT so that they can be consumed at the other end.

Acceptance criteria: 1-Wire sensor samples are successfully consumed at the given MQTT topic.

As an application developer, I want idf.py menuconfig to include configuration elements specific to A4988 stepper driver.

Acceptance criteria: idf.py menuconfig allows to set the following parameters:

• Enable or disable A4988 support completely
• Enable or disable microstepping support
• Enable or disable power saving feature support
• Choose GPO pins for individual functions, with sensible defaults

Note: not enabling extra features frees up to 3 (microstepping) + 1 (power saving) GPIO pins.

As an application developer, I want idf.py menuconfig to include my application's configuration elements so that my application is properly configured.

Acceptance criteria: idf.py menuconfig allows to set the following parameters:

• WiFI access point:
  • SSID
  • security token
• MQTT:
  • Broker MQTT URL
  • Root publish topic
  • Root subscribe topic
• 1-Wire (also see #8):
  • GPIO pin
  • Poll interval
• A4988 stepper driver: see #7
• When PKI is supported,
  • Public key
  • Private key

As an application developer, I want my project to not depend on WiFi and Ethernet connectivity example code so that it can be packaged and distributed independently.

Acceptance criteria: there are no references to components $ENV{IDF_PATH}/examples in the code.

As an application developer, I want to implement access to 1-Wire devices so that I can read sensor samples off them.

Acceptance criteria: the code is able to

• Access 1-Wire bus
• Identify devices connected to the bus
• Read sensor status

Starting point: https://github.com/DavidAntliff/esp32-ds18b20-example

As an application developer, I want to be able to code in C++ so that I can, well, utilize OOP concepts.

Acceptance criteria: ongoing task until all loose ends that it makes sense to convert are converted.

• Expected behavior: As many 1-Wire devices are detected and sampled as there are on the bus.
• Actual behavior: the number is hardcoded at menuconfig time (see 9b44c6fa0f4062299e4f516843c5a07a29fd260c).

Acceptance criteria: the hardcoded limit is removed, and arbitrary number of devices is handled with dynamically allocated memory.

As an Application Developer, I want to implement the LWT (Last Will and Testament) message so that the clients can recover gracefully from hcc-esp32's ungraceful shutdown.

Acceptance Criteria: LWT is received by clients when hcc-esp32 disconnects from the MQTT broker ungracefully.

Reference: https://www.hivemq.com/blog/mqtt-essentials-part-9-last-will-and-testament/

As an application user, I want to be able to enable and disable 1-Wire support so that I can either use 1-Wire devices, or save the GPIO pin for other purposes.

Acceptance criteria:

• 1-Wire subsection in menuconfig can be completely enabled or disabled
• 1-Wire code must not execute if the support is disabled

As an application developer, I want to be able to order A4988 chip to move the stepper in microsteps, so that I can implement silent operation and fine control.

Acceptance criteria: All microstepping modes work as documented.

Depends on #9.

As an application developer, I want to be able to issue direction and step commands via A4988 driver, so that I can control steppers.

Acceptance criteria: direction and step commands issued to A4988 driver API make the stepper move.

As an application developer, I want to be able to use a limit switch and failsafe position with stepper based mechanisms to assure their power loss tolerance.

Acceptance criteria:

• Logic to detect limit switch and disable further stepper movement in a given direction is implemented;
• Logic to move the stepper into a given location on boot is implemented.

As an application developer, I want to use the README.md file from ESP-IDF as a template so that the application specific README.md follows a well established known good structure.

Acceptance criteria: README.md describes the actual application.

As an application developer, I want to be able to issue PWM positioning commands so that RC servos connected to GPIO pins can be controlled.

Acceptance criteria: RC servos connected to GPIO pins execute PWM positioning commands.

Reference: DavidAntliff/esp32-ds18b20-example#17