mirror of
https://github.com/alexhopeoconnor/arduino-home-assistant.git
synced 2026-10-13 23:01:21 +10:00
Dawid ChyrzyńskiandDawid Chyrzynski
0fc32a5bad
* added tests for HADeviceTracker * added support for progmem property value in the HASerializer * codebase update * add support for source type in HADeviceTracker * added support for HACamera * added support for HALock * rename HABinarySensor::getState to getCurrentState * standardize sender name in all callback headers * remove duplicate serializer field protection (reduce flash usage) * optimize HAUtils * minor improvements * optimize writing progmem payload * optimize HAUtils:numberToStr * remove relloc from HASerializer * optimize HASerializerArray * remove includeNullTerminator arg from the topics size generators * optimize HASerializer * replace dtostrf with custom implementation * optimize BaseDeviceType * removed relloc from the HAMqtt * removed support for floats * removed vtable for HADevice, HAMqtt, HASerializer and HASerializerArray * implemented HASwitch with tests * implemented basic HADeviceTrigger * added support for built-in triggers * finished HADeviceTrigger * update changelog * implemented base HASensor * implemented HASensorInteger * finished HASensorFloat * override onMqttConnected in HASensorInteger and HASensorFloat * add more tests for HASensorInteger and HASensorFloat * optimize HASensorFloat * update changelog * standardize constructor of the HABinarySensor * update readme * readme * readme * standardize HADeviceTracker API * standardize HASwitch API * update docs README * move Sphinx files to docsrc directory * type in HASwitch * test docs * add .nojekyll to the docs directory * update makefile of the docs * wip: docs * docs: fix html title * docs: update styling and sidebar * docs: add "Basics" section * docs: device configuration * docs: availability * docs: MQTT discovery * docs: MQTT security * docs: MQTT advanced features * rename BaseDeviceType to HABaseDeviceType * update gitignore * add API reference * update gitignore * HADevice doxygen * doxygen css * HADevice doxygen typos * docs: update links * docs: HAUtils doxygen * HAMqtt and HADevice doxygen * docs: device types * docs: HABaseDeviceType * reduced flash usage by 190 bytes * fix tests * move HAUtils class to the utils directory * make HADevice const in HAMqtt * HABinarySensor docs * doxygen * HADeviceTrigger doxygen * HALock doxygen * HASensor doxygen * HASensor doxygen * HASwitch doxygen * HATagScanner doxygen * HASerializer doxygen * fix SAMD compile error * add HAMqtt::publish method * update examples * add HAButton example * update changelog * added support for the optimistic property in the HACover * do not set optimistic property in the HASwitch if it's set to default value * update examples list * update HASensor example * update MQTT docs * fix device trigger example link * fix search form style on the search result page * added support for the optimistic property in the HALock * update readme * change readme icon * added HALock example * MDNS example * added HASensorFloat and HASensorInteger examples * update readme * update examples * fix crash in the HABaseDeviceType * add support for storing RAM elements in the HASerializerArray * update tests cases in the CoverTest * finished tests for HASelect * added support for HASelect * update README, CHANGELOG and examples list * DeviceTest typos * add more tests to SelectTest * optimize HASelect command's handler * improve CoverTest * optimize HACover command's handler * optimize HALock command's handler * update SerializerTest * remove HAMqtt::writePayload_P method * remove FlagInternalType from the HASerializer * added support for __FlashStringHelper in the topics related functions * migrated serializer to use __FlashStringHelper * add __FlashStringHelper to the HABaseDeviceType::publishOnDataTopic method * move component name to flash memory * update docs * fix debug logs * fix memory leaks * monitor memory leaks in all test cases * optimize tests (RAM) * fix HALock states * fix bug in the HASensor (invalid serialization of the value template property) * fix memory leak in the HASelect * fix crash in HASelect * fix memory leak in the HADeviceTrigger * fix memory leak in the HADevice * tests: add support for ESP8266 and ESP32 envs * update docs * add multi-switch example * update docs structure * update MQTT advanced example in the docs * HADevice: fix _uniqueId memory release * wip: HANumber * add HANumber to defines * refactor HASensor implementation for numbers (again) * update docs * wip: HANumber * wip: add support for number's precision in the HASerializer * add support for float numbers in the HASerializer * optimize vtables in the HASensor * wip: HANumber * fix crash in the float serialization * handle another edge case in the float serialization * replace int32_t with HAUtils::Number type * HANumber fixes * tests for HANumber * change HAUtils::Number type to int64_t * implemented HAUtils::strToNumber * finished HANumber command handler * finished HANumber * update docs * add number example * added support for HAScene * add scene example, update docs * update doxygen * remove memset from the codebase * micro optimizations * fix commands handlers * update HACover code * codebase cleanup * finished HAFan implementation * update docs, added fan example * make json readable in all tests * make position configurable in the HACover * docs * added support for HALight * implement default values as static HAFan members * update docs, added light example * added support for color temperature in the HALight * update light example * update docs * wip: HVAC * improve all tests with callbacks * update logs * add HVAC to the docs * optimize HANumber * add current temperature to the HVAC * started work on HVAC tests * added action feature to the HVAC * add temperature unit to the HVAC * add more tests to UtilsTest * fix fake MQTT messages mock - message shouldn't include null terminator * fix HAUtils::strToNumber * optimize HAFan, HACover and HALight * add min/max temp to the HVAC * added temp step property to the HVAC * rename HASensorNumber::getCurrentValueAsFloat to getCurrentValueFloat * update docs * added support for aux heating in the HVAC * added power command to the HVAC * add subscriptions to the HVAC * added fan mode to the HVAC * update examples * update command handlers in all device types * added swing mode to the HVAC * finished HVAC * update docs * fix memory leak in the HVAC * added support for the target temperature in the HVAC * add HVAC example * update docs * remove unnecessary checks from some device types * added support for RGB in the HALight * update docs * standardize HAHVAC code * rename HAButton::onPress method to onCommand * rename HAScene::onActivate method to onCommand * fix seg fault in the HAUtils * HASensorNumber: do not publish default value on connect * add return uint16_t to the HAUtils::numberToStr method * simplify logic in the HALight::publishRGBColor * optimize numbers serialization in the HASerializer * update README, added LICENSE.md * rename license file * added tag-scanner example * update publishOnDataTopic methods * added esp32-cam example * update docs * add examples to the README.md * update examples * update HAMqtt.h for latest SAMD core, update aunier * update README, fix auniter settings for esp32 * update README * added documentation link to the README * final tweaks in the HACover * fix logic of the speed feature in the HAFan * fix mdns example * fix bug in the DeviceTrigger (invalid serialization of the progmem type/subtype) * implemented HANumeric * update HASensorNumber * update HANumber * update HALight * update HAHVAC * update HAFan * update HACover * update examples * update tests * update docs * fix HANumeric constructor bug * update HANumeric for SAMD * update readme and docs * add payload_on to the scene config (HA throws an exception if this property is missing) * update sensor-analog example * update sensor-integer example * HVAC fixes * update docs Co-authored-by: Dawid Chyrzynski <dawid.chyrzynski@gmail.com>
61 lines
3.1 KiB
ReStructuredText
61 lines
3.1 KiB
ReStructuredText
Examples
|
|
========
|
|
|
|
.. list-table::
|
|
:widths: 25 75
|
|
:header-rows: 1
|
|
:class: examples-table
|
|
|
|
* - Example
|
|
- Description
|
|
* - :example:`Binary sensor <binary-sensor/binary-sensor.ino>`
|
|
- Using the binary sensor as a door contact sensor.
|
|
* - :example:`Button <button/button.ino>`
|
|
- Adding simple buttons to the Home Assistant panel.
|
|
* - :example:`Camera <esp32-cam/esp32-cam.ino>`
|
|
- Publishing the preview from the ESP32-CAM module.
|
|
* - :example:`Cover <cover/cover.ino>`
|
|
- Controlling a window cover (open / close / stop).
|
|
* - :example:`Device trigger <multi-state-button/multi-state-button.ino>`
|
|
- Implementation of a simple wall switch that reports press and hold states.
|
|
* - :example:`Fan <fan/fan.ino>`
|
|
- Controlling a simple fan (state + speed).
|
|
* - :example:`HVAC <hvac/hvac.ino>`
|
|
- HVAC controller with multiple modes, power control and target temperature.
|
|
* - :example:`Lock <lock/lock.ino>`
|
|
- A simple door lock that's controlled by the Home Assistant.
|
|
* - :example:`Light <light/light.ino>`
|
|
- A simple light that allows changing brightness, color temperature and RGB color.
|
|
* - :example:`Number <number/number.ino>`
|
|
- Adding an interactive numeric slider in the Home Assistant panel.
|
|
* - :example:`Scene <scene/scene.ino>`
|
|
- Adding a custom scene in the Home Assistant panel.
|
|
* - :example:`Select <select/select.ino>`
|
|
- A dropdown selector that's displayed in the Home Assistant panel.
|
|
* - :example:`Sensor <sensor/sensor.ino>`
|
|
- A simple sensor that reports a state in a string representation (open / opening / close).
|
|
* - :example:`Analog sensor <sensor-analog/sensor-analog.ino>`
|
|
- Reporting the analog pin's voltage to the Home Assistant.
|
|
* - :example:`Integer sensor <sensor-integer/sensor-integer.ino>`
|
|
- Reporting the device's uptime to the Home Assistant.
|
|
* - :example:`Switch <led-switch/led-switch.ino>`
|
|
- The LED that's controlled by the Home Assistant.
|
|
* - :example:`Multi-switch <multi-switch/multi-switch.ino>`
|
|
- Multiple switches controlled by the Home Assistant.
|
|
* - :example:`Tag scanner <tag-scanner/tag-scanner.ino>`
|
|
- Scanning RFID tags using the MFRC522 module.
|
|
* - :example:`Availability <availability/availability.ino>`
|
|
- Reporting entities' availability (online / offline) to the Home Assistant.
|
|
* - :example:`Advanced availability <advanced-availability/advanced-availability.ino>`
|
|
- Advanced availability reporting with MQTT LWT (Last Will and Testament).
|
|
* - :example:`MQTT advanced <mqtt-advanced/mqtt-advanced.ino>`
|
|
- Subscribing to custom topics and publishing custom messages.
|
|
* - :example:`MQTT with credentials <mqtt-with-credentials/mqtt-with-credentials.ino>`
|
|
- Establishing connection with a MQTT broker using the credentials.
|
|
* - :example:`NodeMCU (ESP8266) <nodemcu/nodemcu.ino>`
|
|
- Basic example for ESP8266 devices.
|
|
* - :example:`Arduino Nano 33 IoT <nano33iot/nano33iot.ino>`
|
|
- Basic example for Arduino Nano 33 IoT (SAMD family).
|
|
* - :example:`mDNS discovery <mdns/mdns.ino>`
|
|
- Make your ESP8266 discoverable via the mDNS.
|