1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
API Reference
=============
Main API
--------
The main entry-point into pyschlage is through the
:class:`pyschlage.Schlage <pyschlage.Schlage>` object.
From there you can access the locks associated with a
Schlage account, and interact with them directly.
.. autoclass:: pyschlage.Schlage
:members:
:special-members: __init__
Authentication
--------------
Creating a :class:`Schlage <pyschlage.Schlage>`
object first requires creating an authentication and
transport object, which is encapsulated in the
:class:`pyschlage.Auth <pyschlage.Auth>` object.
.. autoclass:: pyschlage.Auth
:members:
:special-members: __init__
Locks
-----
The :class:`Schlage <pyschlage.Schlage>` object
provides access to :class:`Lock <pyschlage.lock.Lock>`
objects. Each instance of a :class:`Lock <pyschlage.lock.Lock>`
itself can fetch additional data such as
:class:`access codes <pyschlage.code.AccessCode>` and
:class:`log entries <pyschlage.log.LockLog>`.
.. autoclass:: pyschlage.lock.Lock
:members:
:undoc-members:
.. autoclass:: pyschlage.code.AccessCode
:members:
:undoc-members:
.. autoclass:: pyschlage.code.TemporarySchedule
:members:
:undoc-members:
.. autoclass:: pyschlage.code.RecurringSchedule
:members:
:undoc-members:
.. autoclass:: pyschlage.code.DaysOfWeek
:members:
:undoc-members:
.. autoclass:: pyschlage.log.LockLog
:members:
:undoc-members:
Exceptions
----------
.. automodule:: pyschlage.exceptions
:members:
:undoc-members:
.. toctree::
:maxdepth: 2
:caption: Contents:
|
