Skip to content

Commit c99927d

Browse files
committed
Update README for new MyQAccount class
1 parent 233d8bf commit c99927d

File tree

1 file changed

+24
-10
lines changed

1 file changed

+24
-10
lines changed

README.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -72,26 +72,34 @@ asyncio.get_event_loop().run_until_complete(main())
7272
```
7373
## API Properties
7474

75-
* `accounts`: dictionary with all accounts
76-
* `covers`: dictionary with all covers
77-
* `devices`: dictionary with all devices
78-
* `gateways`: dictionary with all gateways
79-
* `lamps`: dictionary with all lamps
80-
* `last_state_update`: datetime (in UTC) last state update was retrieved
75+
* `accounts`: dictionary with all accounts (MyQAccount)
76+
* `covers`: dictionary with all covers (MyQGarageDoor)
77+
* `devices`: dictionary with all devices (MyQDevice)
78+
* `gateways`: dictionary with all gateways (MyQDevice)
79+
* `lamps`: dictionary with all lamps (MyQLamp)
80+
* `last_state_update`: datetime (in UTC) last state update was retrieved for all items
8181
* `password`: password used for authentication. Can only be set, not retrieved
8282
* `username`: username for authentication.
8383

84-
## Account Properties
84+
## Account Properties (MyQAccount)
8585

86+
* `api`: Associated API object
8687
* `id`: ID for the account
8788
* `name`: Name of the account
89+
* `covers`: dictionary with all covers for account (MyQGarageDoor)
90+
* `devices`: dictionary with all devices for account (MyQDevice)
91+
* `gateways`: dictionary with all gateways for account (MyQDevice)
92+
* `lamps`: dictionary with all lamps for account (MyQLamp)
93+
* `account_json`: Dictionary containing all account information as retrieved from MyQ
94+
* `last_state_update`: datetime (in UTC) last state update was retrieved for all devices within this account
8895

8996
## Device Properties
9097

91-
* `account`: Return account associated with device
98+
* `account`: Return account associated with device (MyQAccount)
9299
* `close_allowed`: Return whether the device can be closed unattended.
93100
* `device_family`: Return the family in which this device lives.
94101
* `device_id`: Return the device ID (serial number).
102+
* `device_json`: Dictionary containing all device information as retrieved from MyQ
95103
* `device_platform`: Return the device platform.
96104
* `device_type`: Return the device type.
97105
* `firmware_version`: Return the family in which this device lives.
@@ -110,16 +118,22 @@ These are coroutines and need to be `await`ed – see `example.py` for examples.
110118
* `authenticate`: Authenticate (or re-authenticate) to MyQ. Call this to
111119
re-authenticate immediately after changing username and/or password otherwise
112120
new username/password will only be used when token has to be refreshed.
113-
* `update_device_info`: Retrieve info and status for accounts and devices
121+
* `update_device_info`: Retrieve info and status for all accounts and devices
114122

115123

124+
## Account Methods
125+
All of the routines on the `MyQAccount` class are coroutines and need to be
126+
`await`ed – see `example.py` for examples.
127+
128+
* `update`: get the latest device info (state, etc.) for all devices associated with this account.
129+
116130
## Device Methods
117131

118132
All of the routines on the `MyQDevice` class are coroutines and need to be
119133
`await`ed – see `example.py` for examples.
120134

121135
* `update`: get the latest device info (state, etc.). Note that
122-
this runs api.update_device_info and thus all accounts/devices will be updated
136+
this runs MyQAccount.update and thus all devices within account will be updated
123137

124138
## Cover Methods
125139

0 commit comments

Comments
 (0)