Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
flip-dots committed May 12, 2024
1 parent 1f449e4 commit de9429a
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,19 @@ The following methods can be used to change the current state of the light.
- :py:meth:`.set_colour_xy`


Automatic Reconnection
^^^^^^^^^^^^^^^^^^^^^^

This module implements two forms of automatic re-connection. The module
listens for disconnection events and only once the light has successfully
been connected to will it attempt to automatically re-establish a connection
if it is lost. The delay to wait between attempts and maximum number of attempts
are defined as module constants which may be overridden.

The other mechanism will attempt to re-establish a connection whenever a method
which requires a connection is called.


Other neat things
^^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit de9429a

Please sign in to comment.