Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
222 changes: 217 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,218 @@
# Ignore all release packages
*.zip
*.rar
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[codz]
*$py.class

# Ignore all automation
*.bat
# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py.cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
# Pipfile.lock

# UV
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# uv.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
# poetry.lock
# poetry.toml

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
# pdm.lock
# pdm.toml
.pdm-python
.pdm-build/

# pixi
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
# pixi.lock
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
# in the .venv directory. It is recommended not to include this directory in version control.
.pixi

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# Redis
*.rdb
*.aof
*.pid

# RabbitMQ
mnesia/
rabbitmq/
rabbitmq-data/

# ActiveMQ
activemq-data/

# SageMath parsed files
*.sage.py

# Environments
.env
.envrc
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
# .idea/

# Abstra
# Abstra is an AI-powered process automation framework.
# Ignore directories containing user credentials, local state, and settings.
# Learn more at https://abstra.io/docs
.abstra/

# Visual Studio Code
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
# and can be added to the global gitignore or merged into this file. However, if you prefer,
# you could uncomment the following to ignore the entire vscode folder
# .vscode/

# Ruff stuff:
.ruff_cache/

# PyPI configuration file
.pypirc

# Marimo
marimo/_static/
marimo/_lsp/
__marimo__/

# Streamlit
.streamlit/secrets.toml

.vscode/
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.14
98 changes: 92 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,98 @@
# LSS_Libraries_Python
# Lynxmotion Smart Servo (LSS) Python Library

Official Lynxmotion Smart Servo (LSS) libraries for Python

Read more about the LSS on our [wiki](https://www.robotshop.com/info/wiki/lynxmotion/view/lynxmotion-smart-servo/).
Read more about the LSS on our [wiki](https://wiki.lynxmotion.com/info/wiki/lynxmotion/view/ses-v2/lynxmotion-smart-servo/).

If you want more details about the LSS protocol, go [here](https://wiki.lynxmotion.com/info/wiki/lynxmotion/view/ses-v2/lynxmotion-smart-servo/lss-communication-protocol/).

To configure your LSS easily, we recommend you try out the [LSS Config](https://www.robotshop.com/products/lynxmotion-lss-configuration-software?qd=e28060e7570ef850c9f4421ea1dccf99).
More details about it [on the wiki](https://wiki.lynxmotion.com/info/wiki/lynxmotion/view/ses-v2/lynxmotion-smart-servo/lss-configuration-software/).

Purchase any LSS model on and accessories at [RobotShop](https://www.robotshop.com)!

Check out blogs, tutorials and post questions on the RobotShop [community site](https://www.robotshop.com/community/).

## Installation

This project uses [uv](https://docs.astral.sh/uv/) for dependency management. If you don't have uv installed:

```bash
# Install uv (Linux/macOS)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Or using pip
pip install uv
```

### Install the library

```bash
# Clone the repository
git clone https://github.com/motius/pyLSS
cd PyLSS

# Install dependencies
uv sync

# Or install in development mode with all dependencies
uv sync --all-groups
```

### Using the library in your project

```python
import serial
from pylss import LSS

# Create and open a serial connection
bus = serial.Serial('/dev/ttyUSB0', 115200, timeout=0.1)

# Create an LSS servo controller for servo ID 5
servo = LSS(5, bus)

# Move to 45 degrees
servo.move_deg(45.0)

# Get current position
position = servo.get_position_deg()
print(f"Current position: {position}°")

# Get servo information
model = servo.get_model()
voltage = servo.get_voltage()
temperature = servo.get_temperature()

print(f"Model: {model}")
print(f"Voltage: {voltage}mV")
print(f"Temperature: {temperature/10}°C")

# Clean up
bus.close()
```

## Running Examples

The repository includes several example scripts in the [examples](examples/) directory:

## Testing

The library includes a comprehensive test suite using pytest with mocked serial communication, so no hardware is required to run tests.

### Run all tests

```bash
# Run all tests
uv run pytest tests/

If you want more details about the LSS protocol, go [here](https://www.robotshop.com/info/wiki/lynxmotion/view/lynxmotion-smart-servo/lss-communication-protocol/).
# Run with verbose output
uv run pytest tests/ -v

To configure your LSS easily, we recommend you try out the [LSS Config](https://www.robotshop.com/en/lynxmotion-smart-servo-lss-configuration-software.html). More details about it [on the wiki](https://www.robotshop.com/info/wiki/lynxmotion/view/lynxmotion-smart-servo/lss-configuration-software/).
# Run with coverage report
uv run pytest tests/ --cov=pylss

Purchase any LSS model on [RobotShop.com](https://www.robotshop.com/en/lynxmotion-smart-servos.html) and get [accessories](https://www.robotshop.com/en/lynxmotion-servos-accessories-1.html), too!
# Run specific test class
uv run pytest tests/test.py::TestLSSActionMethods -v
```

Check out blogs, tutorials and post questions on the Robotshop [community site](https://www.robotshop.com/community/).
All tests use mocked serial objects, making them fast and reliable without requiring physical hardware.
Loading