mirror of
https://github.com/alexhopeoconnor/arduino-home-assistant.git
synced 2026-10-04 02:48:13 +10:00
Add PlatformIO library.json and README note
Declare PubSubClient dependency; document lib_deps for PIO consumers.
This commit is contained in:
@@ -9,6 +9,17 @@ The library is designed to use as low resources (RAM/flash) as possible.
|
||||
Initially, it was optimized to work on Arduino Uno with Ethernet Shield,
|
||||
but I successfully use it on ESP8266/ESP8255 boards in my projects.
|
||||
|
||||
## PlatformIO
|
||||
|
||||
[`library.json`](library.json) declares the **PubSubClient** dependency for Library Manager / LDF. Example:
|
||||
|
||||
```ini
|
||||
lib_deps =
|
||||
https://github.com/alexhopeoconnor/arduino-home-assistant.git
|
||||
```
|
||||
|
||||
(`library.properties` remains the source of truth for the Arduino IDE 1.x/2.x library manager name **home-assistant-integration**.)
|
||||
|
||||
## Features
|
||||
|
||||
* Two-way communication (state reporting and command execution)
|
||||
|
||||
@@ -0,0 +1,50 @@
|
||||
{
|
||||
"name": "home-assistant-integration",
|
||||
"version": "2.1.0",
|
||||
"description": "Home Assistant MQTT integration for Arduino (ArduinoHA): discovery, entities, and low resource use.",
|
||||
"keywords": [
|
||||
"mqtt",
|
||||
"home-assistant",
|
||||
"homeassistant",
|
||||
"arduino",
|
||||
"esp8266",
|
||||
"esp32",
|
||||
"communication",
|
||||
"smarthome"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Dawid Chyrzynski",
|
||||
"email": "dev@chyrzynski.pl"
|
||||
},
|
||||
{
|
||||
"name": "Alex Hope-O'Connor",
|
||||
"email": "alex.hope.oconnor@pomonaqld.au",
|
||||
"maintainer": true
|
||||
}
|
||||
],
|
||||
"license": "MIT",
|
||||
"homepage": "https://github.com/alexhopeoconnor/arduino-home-assistant",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/alexhopeoconnor/arduino-home-assistant.git"
|
||||
},
|
||||
"frameworks": "arduino",
|
||||
"dependencies": [
|
||||
{
|
||||
"name": "knolleary/PubSubClient",
|
||||
"version": "^2.8.0"
|
||||
}
|
||||
],
|
||||
"export": {
|
||||
"include": [
|
||||
"src",
|
||||
"examples",
|
||||
"library.properties",
|
||||
"library.json",
|
||||
"README.md",
|
||||
"LICENSE",
|
||||
"CHANGELOG.md"
|
||||
]
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user