HomeSpan/docs/README.md

1.9 KiB

HomeSpan developer documentation

HomeSpan documentation is devided into multiple documents. From here you will find a summary of each of these documents.

Document Summary
Blinkable Creating a Custom Status LED with the Blinkable Interface
Categories HomeSpan Accessory Categories
CLI The HomeSpan Command-Line Interface (CLI)
Cloning Cloning Pairing Data from one Device to another
FAQ Frequently Asked Questions
Getting Started Getting Started with HomeSpan
HS_STATUS HomeSpan Status, the optional callback whenever HomeSpan status changes.
Logging HomeSpan logging mechanisms.
NOW SpanPoint: Point-to-Point Communication between ESP32 Devices
OTA Over-the-Air (OTA) Updates
Overview HomeSpan API Overview
Pixels Addressable RGB LEDs using the Pixels() class
PWM HomeSpan custom classes using Pulse Width Modulation (PWM) to control Dimmable LEDs as well as Servo Motors
QR Codes Pairing a HomeSpan device to HomeKit with QR Codes
Reference HomeSpan complete API Reference
RMT HomeSpan custom classes to add Remote Control Radio Frequency / Infrared Signal Generation control via HomeKit
Service List HomeSpan Services and Characteristics description
Solution Common Problems and Potential Solutions / Troubleshooting Guide
Stepper HomeSpan dedicated classed to control a stepper motor
Stepper Modes Extra documentation about stepper motor modes
Tutorials HomeSpan Tutorials, to get started.
TV Services Television Services and Characteristics available in HomeSpan
User Guide HomeSpan User Guide. How to control a HomeSpan device