| Name | ftprci JSON |
| Version |
0.2.13
JSON |
| download |
| home_page | None |
| Summary | Cross platform fast time python robot interface controller |
| upload_time | 2024-08-18 23:14:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# FTPRCI
Fast Time Python Robot Controller Interface
## Description
This library is a collection of classes and functions to help with the development
of robot controllers in Python. It is designed to be fast and easy to use, with a
focus on real-time control.
Works on CPython and MicroPython.
## Installation
To install the library, simply run:
```bash
pip install ftprci
```
## Usage
The library is divided into several modules, each with a specific purpose:
* `interface`: Contains the `Interface` class, which is an abstract base class for
all interfaces.
* `actuators`: Contains the `Actuator` class, which is an abstract base class for
all actuators.
* `estimator`: Contains the `Estimator` class, which is an abstract base class for
all estimators.
* `controller`: Contains the `Controller` class, which is an abstract base class
for all controllers.
* `sensor`: Contains the `Sensor` class, which is an abstract base class for all
sensors.
* `logger`: Contains the `Logger` class, which is used for logging.
* `main`: Contains the `RunnerThread` class, which is used to run the controller
with precise timings.
Here is an example of how to use the library:
```python
import ftprci as fci
sensor = fci.LSM6()
controller = fci.PIDController()
estimator = fci.KalmanFilter()
actuator = fci.DCMotor()
th = fci.RunnerThread()
th.callback | sensor.read | estimator.estimate | controller.steer | actuator.command
th.run()
Raw data
{
"_id": null,
"home_page": null,
"name": "ftprci",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Ekter <ektermoi1@proton.me>",
"download_url": "https://files.pythonhosted.org/packages/2e/fa/d45185e584f81b10bd4669af1b04738fdf6dc19962eb7739aeaf26ae8d3a/ftprci-0.2.13.tar.gz",
"platform": null,
"description": "\n# FTPRCI\n\nFast Time Python Robot Controller Interface\n\n## Description\n\nThis library is a collection of classes and functions to help with the development\nof robot controllers in Python. It is designed to be fast and easy to use, with a\nfocus on real-time control.\nWorks on CPython and MicroPython.\n\n\n## Installation\n\nTo install the library, simply run:\n\n ```bash\n pip install ftprci\n ```\n\n## Usage\n\nThe library is divided into several modules, each with a specific purpose:\n* `interface`: Contains the `Interface` class, which is an abstract base class for\nall interfaces.\n* `actuators`: Contains the `Actuator` class, which is an abstract base class for\nall actuators.\n* `estimator`: Contains the `Estimator` class, which is an abstract base class for\nall estimators.\n* `controller`: Contains the `Controller` class, which is an abstract base class\nfor all controllers.\n* `sensor`: Contains the `Sensor` class, which is an abstract base class for all\nsensors.\n* `logger`: Contains the `Logger` class, which is used for logging.\n* `main`: Contains the `RunnerThread` class, which is used to run the controller\nwith precise timings.\n\nHere is an example of how to use the library:\n\n ```python\n import ftprci as fci\n sensor = fci.LSM6()\n controller = fci.PIDController()\n estimator = fci.KalmanFilter()\n actuator = fci.DCMotor()\n th = fci.RunnerThread()\n th.callback | sensor.read | estimator.estimate | controller.steer | actuator.command\n th.run()\n",
"bugtrack_url": null,
"license": null,
"summary": "Cross platform fast time python robot interface controller",
"version": "0.2.13",
"project_urls": {
"Homepage": "https://github.com/Ekter/ftprci",
"Issues": "https://github.com/Ekter/ftprci/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b0b2689696db7e4daa6a930d86dca9ae64708dffe1d1e79a49fbfe3c6a6fa33c",
"md5": "b8cca33660a7376122ccd472c0102fd8",
"sha256": "8515c582acda1f28809caf1bf8d29b36504b835300aac0a2bf5878d9ce711021"
},
"downloads": -1,
"filename": "ftprci-0.2.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b8cca33660a7376122ccd472c0102fd8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 10973,
"upload_time": "2024-08-18T23:14:11",
"upload_time_iso_8601": "2024-08-18T23:14:11.573551Z",
"url": "https://files.pythonhosted.org/packages/b0/b2/689696db7e4daa6a930d86dca9ae64708dffe1d1e79a49fbfe3c6a6fa33c/ftprci-0.2.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2efad45185e584f81b10bd4669af1b04738fdf6dc19962eb7739aeaf26ae8d3a",
"md5": "3b0a50c4a67ecde4a6dbff8693744a06",
"sha256": "ba8e66aad26dcdbbb55669c883cf79728952aa57e18fe5d958e6348a52606062"
},
"downloads": -1,
"filename": "ftprci-0.2.13.tar.gz",
"has_sig": false,
"md5_digest": "3b0a50c4a67ecde4a6dbff8693744a06",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9315,
"upload_time": "2024-08-18T23:14:13",
"upload_time_iso_8601": "2024-08-18T23:14:13.294572Z",
"url": "https://files.pythonhosted.org/packages/2e/fa/d45185e584f81b10bd4669af1b04738fdf6dc19962eb7739aeaf26ae8d3a/ftprci-0.2.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-18 23:14:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Ekter",
"github_project": "ftprci",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "ftprci"
}
