InOrbit Python Edge SDK
Project description
InOrbit Python Edge SDK
The InOrbit Edge SDK
allows Python programs to communicate with InOrbit
platform on behalf of robots - providing robot data and handling robot actions. It's goal is to ease the integration between InOrbit
and any other software that handles robot data.
Features
- Robot session handling through a
RobotSessionPool
. - Publish key-values.
- Publish robot poses.
- Publish robot odometry.
Quick Start
from inorbit_edge.robot import RobotSessionFactory, RobotSessionPool
robot_session_factory = RobotSessionFactory(api_key="<YOUR_API_KEY>")
robot_session_pool = RobotSessionPool(robot_session_factory)
robot_session = robot_session_pool.get_session(
robot_id="my_robot_id_123", robot_name="Python SDK Quick Start Robot"
)
robot_session.publish_pose(x=0.0, y=0.0, yaw=0.0)
Installation
Stable Release: pip install edge-sdk-python
Development Head: pip install git+https://github.com/inorbit-ai/edge-sdk-python.git
Documentation
For full package documentation please visit InOrbit Developer Portal.
Development
See CONTRIBUTING.md for information related to developing the code.
The Three Commands You Need To Know
-
pip install -e .[dev]
This will install your package in editable mode with all the required development dependencies (i.e.
tox
). -
make build
This will run
tox
which will run all your tests in both Python 3.7 and Python 3.8 as well as linting your code. -
make clean
This will clean up various Python and build generated files so that you can ensure that you are working in a clean environment.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for inorbit_edge-0.1.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36363d96dc3f37bcc551fe56976fb1d9f6b9e0ebdf7334582e8e24ab9c10a267 |
|
MD5 | 772e39c092d77f4bef840bb99cc962d2 |
|
BLAKE2b-256 | c2c813895f6e554924835795825facc839ad5a202fa8cf82df8556674ee5f3e3 |