Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.11 KB

neobeeshell.rst

File metadata and controls

36 lines (25 loc) · 1.11 KB

NeoBeeShell

NeoBeeShell is the main class to interact with the controller programmatically. The purpose if the library is to read and write the configuration settings. The library uses a tcp communication. So to use the library, you do not need the serial line of the usb cable. The benfit of this approach is, that you are able to accessthe board remotely as long as you are in the same network.

Because a tcp socket is used, it is important to close the socket at the end. The NeoShell class implements pythons context protocol. Therefore you can use it in a with clause, which garantuees to close the socket. No need to open and close the socket. Thats all managed for you in the background. It makes code safer and more human readable.

Here's an example:

with NeoBeeShell(host="192.168.178.80") as s:
    name = s.name
    s.wifi_password = "mysecret"
    s.save_configuration()

API Documentation

.. autoclass:: neobee.shell.NeoBeeShell
    :members: