A CLI tool to control Roomba
Project description
S.P.A.R.K
~ Smart Programmable Agent for Roomba with Knowledge ~
[🌐 Website] • [🐱 GitHub] [🐦 Twitter] • [🍀 Official Blog]
[!IMPORTANT] このリポジトリのリリースノートやREADME、コミットメッセージの9割近くはclaude.aiやChatGPT4を活用したAIRA, SourceSage, Gaiah, HarmonAI_IIで生成しています。
プロジェクト概要
SPARK (Smart Programmable Agent for Roomba with Knowledge) は、Roombaロボット掃除機を制御するためのPythonベースのCLIツールです。このプロジェクトは、Roombaの遠隔操作や自動化を可能にし、より柔軟な清掃プロセスの実現を目指しています。
機能
- Roombaの速度と角速度の制御
- コマンドラインインターフェース(CLI)を通じた操作
- ロギング機能によるデバッグと操作履歴の記録
インストール
SPARKは、Poetry を使用して依存関係を管理しています。以下の手順でインストールできます:
pip install spark-roomba
使用方法
SPARKは、コマンドラインから以下のように使用できます:
spark-roomba drive <speed> <deg>
<speed>
: Roombaの速度(cm/s)<deg>
: Roombaの角速度(deg/s)
例:
spark-roomba drive 20 45
この例では、Roombaを20 cm/sの速度で前進させ、同時に45 deg/sの角速度で回転させます。
開発環境のセットアップ
-
リポジトリをクローンします:
git clone https://github.com/Sunwood-ai-labs/SPARK.git cd SPARK
-
Poetry をインストールします(まだの場合):
curl -sSL https://install.python-poetry.org | python3 -
-
プロジェクトの依存関係をインストールします:
poetry install
-
開発用の仮想環境を有効化します:
poetry shell
Docker を使用した開発
プロジェクトには Docker と docker-compose の設定が含まれています。以下のコマンドで開発環境を起動できます:
docker-compose up -d
これにより、Pythonと必要な依存関係がインストールされたコンテナが起動します。
ライセンス
このプロジェクトは MIT ライセンスの下で公開されています。詳細は LICENSE ファイルをご覧ください。
貢献
プロジェクトへの貢献を歓迎します。バグ報告、機能リクエスト、プルリクエストなど、あらゆる形での貢献をお待ちしています。
リンク
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 spark_roomba-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b03dd26f29c8979bb7ea883054cfc617d50a31ee5f61ff4a83192d5551053c3 |
|
MD5 | 44d0dec0924cbc77b53181d639134cfb |
|
BLAKE2b-256 | c2a12168c70f8565e30060c9a66c7bdfb19b2e1f07ab20e8bcb2eaadfe16637d |