Skip to content

Latest commit

 

History

History
96 lines (59 loc) · 3.22 KB

README.md

File metadata and controls

96 lines (59 loc) · 3.22 KB

Luos logo

Build Status

Pyluos

Pyluos lets you easily connect, interact and program your luos based devices.

The API was designed to be as simple as possible and let you focus on bringing life to your ideas!

Read the complete documentation of Pyluos.

Install Pyluos

From pypi (master branch stable):

pip install pyluos

From pypi (master branch pre-release):

pip install --pre pyluos

Or clone from git:

git clone https://github.com/Luos-io/pyluos

Compatibility

Pyluos is a pure-python library and works with Python >= 2.7 or 3.4 and later.

Quickstart

Pyluos API was designed to be as simple as possible so you can directly focus on the application you want to make!

Connecting

Connecting to your device is really easy. It actually takes only two lines of code.

On WiFi

from pyluos import Device

device = Device('my_robot_hostname.local')

On serial

from pyluos import Device

device = Device('my_serial_port')

The my_serial_port will look something like COM3 on a Windows device, or /dev/ttyUSB on a Mac or Linux device.

Finding a gate

If you don't know the name of a gate, you can easily find it using the pyluos-usb-gate and pyluos-wifi-gate command line utilities. They should be automatically installed when you install Pyluos, and available in your path. From the terminal, you can run:

pyluos-wifi-gate discover

This will show the name of the WiFi gate connected on the same WiFi. This uses the Zeroconf protocol.

Make sure to use either the IP or the hostname.local for WiFi gates.

Similarly, to find the name of the USB gate connected to your machine you can run: pyluos-usb-gate discover

You can then uses the found name to connect to it via Pyluos:

from pyluos import Device
device = Device('/dev/cu.usbmodem2964691')

Contributing

Pyluos is developed by Luos with the support of Pollen Robotics.

Pyluos still needs lots of usage and testing to help it become more useful and reliable. If you are actively using Pyluos, and have suggestion or comments, please let us know!

Do not hesitate to share your experience with Pyluos and meet other Luos users on our forum!

License

Pyluos is licensed under the MIT license.