Skip to content

Commit 83daa18

Browse files
committed
clean readme
1 parent d52b2f3 commit 83daa18

2 files changed

Lines changed: 2 additions & 79 deletions

File tree

README.md

Lines changed: 1 addition & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This software is not affiliated with Verisure Holding AB and the developers take
77

88
### Version History
99
```
10+
2.1.1 Cleaned up readme
1011
2.1.0 Add door-lock-configuration command
1112
2.0.0 Move to GraphQL API, major changes
1213
1.0.0 Move to app-API, major changes
@@ -90,81 +91,3 @@ output:
9091

9192
``` vsure user@example.com mypassword --arm-state --door-window ```
9293

93-
94-
# DEPRICATED BELOW THIS LINE
95-
96-
97-
### Filter out door lock status from overview
98-
99-
``` vsure user@example.com mypassword overview doorLockStatusList ```
100-
101-
### Disarm
102-
103-
``` vsure user@example.com mypassword set alarm 1234 DISARMED ```
104-
105-
### Unlock door
106-
107-
``` vsure user@example.com mypassword set lock 123456 '6EA1 A422' unlock ```
108-
109-
### Turn on smartplug
110-
111-
``` vsure user@example.com mypassword set smartplug '5AC2 4LXH' on ```
112-
113-
### Get event log with filter for arm and disarm events
114-
115-
``` vsure user@example.com mypassword eventlog -f ARM DISARM ```
116-
117-
## Module usage
118-
119-
### Read alarm status
120-
121-
122-
```
123-
import verisure
124-
125-
session = verisure.Session('user@example.com', 'mypassword')
126-
session.login()
127-
armstate = session.get_arm_state()
128-
session.logout()
129-
print(armstate["statusType"])
130-
```
131-
132-
### Set alarm status
133-
```
134-
import verisure
135-
136-
session = verisure.Session('user@example.com', 'mypassword')
137-
session.login()
138-
session.set_arm_state('1234', 'ARMED_HOME')
139-
session.logout()
140-
```
141-
142-
### Turn on smartplug
143-
```
144-
import verisure
145-
146-
session = verisure.Session('user@example.com', 'mypassword')
147-
session.login()
148-
session.set_smartplug_state('1A2B 3C4D', True)
149-
session.logout()
150-
```
151-
152-
### Read status of all devices
153-
```
154-
import verisure
155-
156-
session = verisure.Session('user@example.com', 'mypassword')
157-
session.login()
158-
overview = session.get_overview()
159-
session.logout()
160-
```
161-
162-
### Get event log
163-
```
164-
import verisure
165-
166-
session = verisure.Session('user@example.com', 'mypassword')
167-
session.login()
168-
events = session.get_history(('ARM', 'DISARM'))
169-
session.logout()
170-
```

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
setup(
66
name='vsure',
7-
version='2.1.0',
7+
version='2.1.1',
88
description='Read and change status of verisure devices through mypages.',
99
long_description='A python3 module for reading and changing status of '
1010
+ 'verisure devices through mypages.',

0 commit comments

Comments
 (0)