-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation on supporting new devices.
Cribbed from MisterWil/abodepy#10
- Loading branch information
Showing
2 changed files
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
:tocdepth: 2 | ||
|
||
Supporting New Devices | ||
====================== | ||
|
||
For new devices to be added to this library, the maintainers need the json values for each device. These values can be found by inspecting the network activity on the Abode webapp and pulling the data from the devices request or by using the CLI. | ||
|
||
Getting Devices through Web App | ||
------------------------------- | ||
|
||
#. In a web browser, navigate to https://my.goabode.com/#/login | ||
#. Open `Developer Tools <https://balsamiq.com/support/faqs/browserconsole/>`_ | ||
#. Click on "Network" to record network activity | ||
#. Complete the login | ||
#. Find "devices" under the Name column | ||
#. Right click on the row and Copy -> Copy Response | ||
|
||
Getting Devices through the CLI | ||
------------------------------- | ||
|
||
#. Follow the install directions | ||
#. Run ``abode -u USERNAME -p PASSWORD --devices`` to get a list of devices | ||
#. Run ``abode -u USERNAME -p PASSWORD --json DEVICE_ID`` with the device ID of the device of interest | ||
#. Copy JSON data from the output | ||
|
||
Remove identifying info (if applicable) and `create an issue <https://github.com/jaraco/jaraco.abode/issues/new>`_ with the data. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,6 +9,7 @@ Welcome to |project| documentation! | |
:maxdepth: 1 | ||
|
||
history | ||
developing | ||
api | ||
|
||
|
||
|