From 8202545f9a24c0626406deca9edecfc4573206eb Mon Sep 17 00:00:00 2001 From: rworne Date: Sun, 13 Sep 2020 18:10:56 -0700 Subject: [PATCH] Update README.md --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b1d937..fddc14f 100644 --- a/README.md +++ b/README.md @@ -1 +1,34 @@ -# homebridge-gz-yeti \ No newline at end of file +# homebridge-gz-yeti + +**WIP** + +My initial take on a Homebridge plugin dor the Goal Zero Yeti power stations (Lithium Ion powered generator). +This provides remote power capability for 12VDC, AC power and USB power, shows the charge state of the battery, and the temperature of the Yeti itself. + +## Usage: + +Configure it as follows: + + { + "accessory": "gz-yeti", + "service": "Switch", + "name": "Yeti", + "url": "http://[your Yeti's IP Address]", + "model": "Your Yeti Model", + "devname": "Your Yeti device name", + "serialnumber": "Your Yeti Serial number", + "firmwareversion": "Your firmware revision", + "showHumidity": "no" + } + +### Note: + * Only the url is critical, the rest of the fields are for information or future development. These values can be found in the Yeti app. + * name is the name of the device as it appears in Homekit + * model appears under the detailed info page in the settings page for the device in Home.app. + * serialnumber appears under the detailed info page in the settings page for the device in Home.app. + * showHumidity will use the humidity sensor in Homekit to display the charge state of the battery - it's otherwise buried. + * firmware version is currently not used, it's there in case any future firmware updates cause breakage. + * Siri responds to "Turn AC Power on/off", "Turn 12 volt power on/off", "Turn USB power on/off" + +Credit goes to dinmammas for his homebridge-robonect plugin. It provided a basic enough example to use, so any similarities are intentional. +