Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rroemhild committed Nov 27, 2019
1 parent 20f8076 commit a1a33c1
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/reference/utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,24 @@ This module provides helper functions.

.. function:: disable_ap()

Function to disable the device Wifi Access Point. For the ESP8266 Microhomie firmwares this function will be excecuted on boot.

.. function:: get_unique_id()

Return a unique device id as bytestring.

.. function:: get_local_ip()

Return the device IP address, if possible.

.. function:: get_local_mac()

Return the device MAC address, if possible.

.. function:: payload_is_valid()

Helper function to validate payload for node properties.

This function does only test if the payload match the datatype, but the format the payload has to be in, for now.

Returns ``True`` or ``False``.

0 comments on commit a1a33c1

Please sign in to comment.