| Name | my-bittle JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | |
| Summary | A small package to enable keyboard control of the Bittle robot dog. |
| upload_time | 2024-01-24 00:51:36 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
pyserial
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# my_bittle
This is a package that enables control via keyboard or api of
the [Bittle robot from Petoi](https://www.petoi.com/pages/bittle-open-source-bionic-robot-dog). This project is not
affiliated with petoi or bittle officially. Try this project with your bittle on a test stand first where bittle's feat
can't touch the ground, as it may result in commands that break your bittle.
The intent of this package is to make it easier to use a raspberry pi to control the bittle and build custom behavior
using a raspberry pi. That said if you have a serial port open to the bittle on windows, it'll work too.
## Installation
```
pip install my-bittle
```
## Keyboard Control Usage
Connect to the bittle via serial (bluetooth, cable, ect).
On windows, something like this:
```
bittle-keyboard-control COM11
```
On linux, something like this:
```
bittle-keyboard-control /dev/ttyS0
```
## API Usage
```python
import time
from my_bittle.bittle_serial_controller import BittleSerialController, BittleCommand
port = "/dev/ttyS0"
my_bittle_controller = BittleSerialController(port=port)
my_bittle_controller.start()
my_bittle_controller.command_bittle(BittleCommand.FORWARD)
time.sleep(2)
my_bittle_controller.stop()
```
To see all available commands:
```python
from my_bittle.bittle_serial_controller import BittleCommand
BittleCommand.print_all()
```
To send a custom command:
```python
import time
from my_bittle.bittle_serial_controller import BittleSerialController
port = "/dev/ttyS0"
my_bittle_controller = BittleSerialController(port=port)
my_bittle_controller.start()
my_bittle_controller._send_cmd("b1 2 4 6")
time.sleep(2)
my_bittle_controller.stop()
```
## Troubleshooting
Blank.
Raw data
{
"_id": null,
"home_page": "",
"name": "my-bittle",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "MZandtheRaspberryPi <mzandtheraspberrypi@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/67/cb/2aff2da71abc1640d388f965584155c5c6bff556bc03c921c85d9b6154ff/my-bittle-0.0.4.tar.gz",
"platform": null,
"description": "# my_bittle\n\n\n\nThis is a package that enables control via keyboard or api of\nthe [Bittle robot from Petoi](https://www.petoi.com/pages/bittle-open-source-bionic-robot-dog). This project is not\naffiliated with petoi or bittle officially. Try this project with your bittle on a test stand first where bittle's feat\ncan't touch the ground, as it may result in commands that break your bittle.\n\nThe intent of this package is to make it easier to use a raspberry pi to control the bittle and build custom behavior\nusing a raspberry pi. That said if you have a serial port open to the bittle on windows, it'll work too.\n\n## Installation\n\n```\npip install my-bittle\n```\n\n## Keyboard Control Usage\n\nConnect to the bittle via serial (bluetooth, cable, ect).\n\nOn windows, something like this:\n\n```\nbittle-keyboard-control COM11\n```\n\nOn linux, something like this:\n\n```\nbittle-keyboard-control /dev/ttyS0\n```\n\n## API Usage\n\n```python\nimport time\n\nfrom my_bittle.bittle_serial_controller import BittleSerialController, BittleCommand\n\nport = \"/dev/ttyS0\"\nmy_bittle_controller = BittleSerialController(port=port)\n\nmy_bittle_controller.start()\nmy_bittle_controller.command_bittle(BittleCommand.FORWARD)\ntime.sleep(2)\nmy_bittle_controller.stop()\n```\n\nTo see all available commands:\n\n```python\nfrom my_bittle.bittle_serial_controller import BittleCommand\n\nBittleCommand.print_all()\n```\n\nTo send a custom command:\n\n```python\nimport time\n\nfrom my_bittle.bittle_serial_controller import BittleSerialController\n\nport = \"/dev/ttyS0\"\nmy_bittle_controller = BittleSerialController(port=port)\n\nmy_bittle_controller.start()\nmy_bittle_controller._send_cmd(\"b1 2 4 6\")\ntime.sleep(2)\nmy_bittle_controller.stop()\n```\n\n## Troubleshooting\n\nBlank.\n",
"bugtrack_url": null,
"license": "",
"summary": "A small package to enable keyboard control of the Bittle robot dog.",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/MZandtheRaspberryPi/my_bittle"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1aaa2aa1739449a2d8a95b48c4c3bea584e9bb0ef68e39a004b399f88634e027",
"md5": "20ad928468104ace42c0cb794e9cc5ef",
"sha256": "3d952ce26f61fe8d302c15893e1ece41d56a11284a88adcc4869983e3be60de2"
},
"downloads": -1,
"filename": "my_bittle-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "20ad928468104ace42c0cb794e9cc5ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6081,
"upload_time": "2024-01-24T00:51:35",
"upload_time_iso_8601": "2024-01-24T00:51:35.542758Z",
"url": "https://files.pythonhosted.org/packages/1a/aa/2aa1739449a2d8a95b48c4c3bea584e9bb0ef68e39a004b399f88634e027/my_bittle-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "67cb2aff2da71abc1640d388f965584155c5c6bff556bc03c921c85d9b6154ff",
"md5": "b9997189eed9a5bdc278a887af16b86f",
"sha256": "cbfb707050cd649178d6a97492a618a55b31c532c05da2108b9f0f6bd9686f7c"
},
"downloads": -1,
"filename": "my-bittle-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "b9997189eed9a5bdc278a887af16b86f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5223,
"upload_time": "2024-01-24T00:51:36",
"upload_time_iso_8601": "2024-01-24T00:51:36.881067Z",
"url": "https://files.pythonhosted.org/packages/67/cb/2aff2da71abc1640d388f965584155c5c6bff556bc03c921c85d9b6154ff/my-bittle-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-24 00:51:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MZandtheRaspberryPi",
"github_project": "my_bittle",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pyserial",
"specs": []
}
],
"lcname": "my-bittle"
}
