https://github.com/animatedledstrip/client-python

Library for connecting to an AnimatedLEDStrip server from clients written in Python 3
https://github.com/animatedledstrip/client-python

als-client-library als-library

Last synced: 8 months ago
JSON representation

Library for connecting to an AnimatedLEDStrip server from clients written in Python 3

• Host: GitHub
• URL: https://github.com/animatedledstrip/client-python
• Owner: AnimatedLEDStrip
• License: mit
• Created: 2020-07-19T18:58:42.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-28T19:33:51.000Z (about 2 years ago)
• Last Synced: 2025-09-15T02:39:45.656Z (9 months ago)
• Topics: als-client-library, als-library
• Language: Python
• Homepage:
• Size: 98.6 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.com/AnimatedLEDStrip/client-python.svg?branch=master)](https://travis-ci.com/AnimatedLEDStrip/client-python)

[![PyPI](https://img.shields.io/pypi/v/animatedledstrip-client.svg)](https://pypi.python.org/pypi/animatedledstrip-client)

[![codecov](https://codecov.io/gh/AnimatedLEDStrip/client-python/branch/master/graph/badge.svg)](https://codecov.io/gh/AnimatedLEDStrip/client-python)

# AnimatedLEDStrip Client Library for Python

This library allows a Python 3 client to communicate with an AnimatedLEDStrip server.

## Adding the Library to a Project

The library is available via pip:

```bash

pip3 install animatedledstrip-client

```

## Creating an `AnimationSender`

An `ALSHttpClient` is created with `ALSHttpClient(ip_address)`.

```python

from animatedledstrip import ALSHttpClient

sender = ALSHttpClient('10.0.0.254')

```

## Communicating with the Server

This library follows the conventions laid out for [AnimatedLEDStrip client libraries](https://animatedledstrip.github.io/clients/libraries), with the following modifications:

- Function names and class variables are in snake case to follow Python style conventions

- `get_supported_animations_dict` is provided as an alias for `get_supported_animations_map`

- `get_sections_dict` is provided as an alias for `get_sections_map`