Seich
/
HomeSpan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adding README.md for docs. Page summary.

This commit is contained in:
Francois 2024-01-08 17:03:20 -05:00
parent 39b7b54d48
commit fa7e5ed94a
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/README.md Normal file
View File

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