| Name | raccoonlab-tools JSON |
| Version |
0.0.18
JSON |
| download |
| home_page | None |
| Summary | RaccoonLab tools |
| upload_time | 2024-03-31 10:27:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
cyphal
dronecan
can
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.org/project/raccoonlab-tools/) [](https://sonarcloud.io/summary/new_code?id=PonomarevDA_tools) [](https://github.com/PonomarevDA/tools/actions/workflows/cyphal_init.yml) [](https://github.com/PonomarevDA/tools/actions/workflows/specification_checker.yml)
# Cyphal/DroneCAN nodes tools
`tools` is a collection of scripts for testing and configuration of Cyphal/CAN and DroneCAN nodes.
> This package is under development.
## 1. INSTALLATION
**1. Install the package from pypi, test.pypi or from sources**
```bash
pip install raccoonlab-tools
```
```bash
pip install -i https://test.pypi.org/simple/ raccoonlab-tools
```
```bash
git clone https://github.com/PonomarevDA/tools.git
cd tools
pip install .
```
**2. Install dependencies**
If you already have a Cyphal in your system, you probably don't need to install anything additional and have your own way of handling the environment variables and DSDL. Just check [scripts/ubuntu.sh](scripts/ubuntu.sh) script in case if you miss something.
But if you use Cyphal for the first time or deploy a project in a new system, consider to run [scripts/ubuntu.sh](scripts/ubuntu.sh) script. This script:
1. Install all recommended dependencies,
2. Clone recommended DSDL to `~/.cyphal` directory,
3. Create in `~/.cyphal` directory a `setup.sh` script that configure cyphal related environment variables and append `source $HOME/cyphal/setup.sh` to the end of your `.bashrc` file, so your shell will automatically setup the environment variables.
```bash
# By default, it installs both Cyphal and DroneCAN dependencies:
./scripts/ubuntu.sh
# Try --help option to get usage details. It allows to perform more precise installation:
./scripts/ubuntu.sh --help
```
<details><summary>Click here for details about which environment variables are required for a Cyphal application</summary>
To start with Cyphal/CAN (pycyphal, yakut, yukon) the following environment variables should be configured:
| Environment variable | Meaning |
| -------------------- | - |
| CYPHAL_PATH | Path to DSDL. Let's use the default:`$HOME/.cyphal` |
| UAVCAN__NODE__ID | The application node identifier |
| UAVCAN__CAN__IFACE | CAN iface name |
| UAVCAN__CAN__BITRATE | Arbitration/data segment bits per second |
| UAVCAN__CAN__MTU | Maximum transmission unit: 8 for classic CAN |
> Check pycyphal/yakut/yukon docs for additional details
</details>
## 2. LINUX PREPARATION (SOCKETCAN)
By default, DroneCAN and Cyphal/CAN uses cross-platform transport interface [Python-CAN](https://python-can.readthedocs.io/en/stable/) [CAN over Serial / SLCAN](https://python-can.readthedocs.io/en/stable/interfaces/slcan.html).
On Linux, [the socketcan interface](https://python-can.readthedocs.io/en/stable/interfaces/socketcan.html) is recommended. Unlike SLCAN, socketcan interface allows to share the same CAN interface with multiple processes, so you can run a few pycyphal scripts, yukon, yakut simultaniously.
You can run the following script:
```bash
./scripts/socketcan.sh
```
For a Cyphal application after creating socketcan interface, you need to update `UAVCAN__CAN__IFACE` environment variable. Just call `source ~/.bashrc`.
## 3. USAGE
### 1. Test cyphal specification
```bash
rl-test-cyphal-specification
```
### 2. Test dronecan specification
```bash
rl-test-dronecan-specification
```
```bash
rl-test-dronecan-gps-mag-baro
```
### 3. Get Node Info (Cyphal / DroneCAN)
```bash
rl-get-info
```
Return:
- Online CAN-sniffers
- Detect protocol if any CAN-node is avaliable: cyphal | dronecan | none
- Show node info of Cyphal/CAN or DroneCAN node if it is avaliable
### 4. Upload firmware with st-link linux / STM32CubeProgrammer Windows
```bash
rl-upload-firmware --config PATH_TO_YAML_CONFIG
```
```bash
rl-upload-firmware --binary PATH_TO_BIN_FILE
```
There are a few ways how you can specify the path to the binary:
1. (recommended) Using a GitHub Repository. It will always download the latest released firmware.
```yaml
# config.yaml
metadata:
link: RaccoonlabDev/mini_v2_node
```
2. Direct Link to the Firmware File
```yaml
# config.yaml
metadata:
link: https://github.com/RaccoonlabDev/docs/releases/download/v1.6.5/gnss_v2_cyphal_v1.6.5_c78d47c3.bin
```
3. Using a Local Path
```yaml
# config.yaml
metadata:
link: /user/home/firmwares/node.bin
```
4. Direct .bin path with `--binary` option
### 5. Upload config
```bash
rl-config --config PATH
```
Example of yaml config file:
```yaml
# config.yaml
params:
uavcan.node_id: 31
uavcan.node.name: co.rl.mini
```
### 6. Monitor
```bash
rl-monitor
```
This script is used for automated node analysis. Within a single command:
- detect the protocol (Cyphal or DroneCAN),
- detect the node type,
- check the software version and highlight if it is not the latest,
- configure it if it has not been configured yet,
- subscribes on all possible topics,
- provide basic tests and diagnostics, highlight issues,
- publish some test commands if possible,
- print all data in real time.
An example of `rl-monitor` with gnss node:
### 7. U-center with Cyphal GNSS
```bash
rl-ublox-center
```
For RL GNSS it is possible to run u-center over Cyphal via `gps.ubx_tx` and `gps.ubx_rx` topics.
1. Download [u-center](https://www.u-blox.com/en/product/u-center) (tested with u-center 23.08)
2. Run the u-center. On ubuntu you can use wine (`wine64 u-centersetup_v23.08/u-center_v23.08.exe`)
3. Configure the Cyphal environment
4. Run the script `rl-ublox-center`
5. Press Receiver - > Connection -> Network connection
6. Add new connection `tcp://127.0.0.1:2001`
An illustration:
<!--
### 6. Upload cyphal parameters
### UC7-8. Check cyphal/dronecan node type by name
rl-give-node-type
### UC9. Check RL firmware version
rl-check-updates
### UC10. Check other (custom) vendors firmware version
...
### UC11-12. Create socketcan linux (real/virtual)
rl-socketcan
### UC13-14. Create slcan linux/windows -->
## 4. DEVELOPER NOTES
Deploy to [TestPyPI](https://test.pypi.org/project/raccoonlab-tools/):
```bash
./scripts/deploy.sh
```
Deploy to [PyPI](https://pypi.org/project/raccoonlab-tools/):
```bash
./scripts/deploy.sh --pypi
```
## 5. USAGE TERMS
The scripts are distributed under MIT license. In general, you can do with them whatever you want. If you find a bug, please suggest a PR or an issue.
Raw data
{
"_id": null,
"home_page": null,
"name": "raccoonlab-tools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "cyphal, dronecan, can",
"author": null,
"author_email": "Dmitry Ponomarev <PonomarevDA96@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/67/8f/6df7020b63a98be3832ece59f865c63fde66c06be8b55baf3689f0df3bf2/raccoonlab-tools-0.0.18.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/raccoonlab-tools/) [](https://sonarcloud.io/summary/new_code?id=PonomarevDA_tools) [](https://github.com/PonomarevDA/tools/actions/workflows/cyphal_init.yml) [](https://github.com/PonomarevDA/tools/actions/workflows/specification_checker.yml)\n\n# Cyphal/DroneCAN nodes tools \n\n`tools` is a collection of scripts for testing and configuration of Cyphal/CAN and DroneCAN nodes.\n\n> This package is under development.\n\n## 1. INSTALLATION\n\n**1. Install the package from pypi, test.pypi or from sources**\n\n```bash\npip install raccoonlab-tools\n```\n```bash\npip install -i https://test.pypi.org/simple/ raccoonlab-tools\n```\n```bash\ngit clone https://github.com/PonomarevDA/tools.git\ncd tools\npip install .\n```\n\n**2. Install dependencies**\n\nIf you already have a Cyphal in your system, you probably don't need to install anything additional and have your own way of handling the environment variables and DSDL. Just check [scripts/ubuntu.sh](scripts/ubuntu.sh) script in case if you miss something.\n\nBut if you use Cyphal for the first time or deploy a project in a new system, consider to run [scripts/ubuntu.sh](scripts/ubuntu.sh) script. This script:\n1. Install all recommended dependencies,\n2. Clone recommended DSDL to `~/.cyphal` directory,\n3. Create in `~/.cyphal` directory a `setup.sh` script that configure cyphal related environment variables and append `source $HOME/cyphal/setup.sh` to the end of your `.bashrc` file, so your shell will automatically setup the environment variables.\n\n```bash\n# By default, it installs both Cyphal and DroneCAN dependencies:\n./scripts/ubuntu.sh\n\n# Try --help option to get usage details. It allows to perform more precise installation:\n./scripts/ubuntu.sh --help\n```\n\n<details><summary>Click here for details about which environment variables are required for a Cyphal application</summary>\n\nTo start with Cyphal/CAN (pycyphal, yakut, yukon) the following environment variables should be configured:\n\n| Environment variable | Meaning |\n| -------------------- | - |\n| CYPHAL_PATH | Path to DSDL. Let's use the default:`$HOME/.cyphal` |\n| UAVCAN__NODE__ID | The application node identifier |\n| UAVCAN__CAN__IFACE | CAN iface name |\n| UAVCAN__CAN__BITRATE | Arbitration/data segment bits per second |\n| UAVCAN__CAN__MTU | Maximum transmission unit: 8 for classic CAN |\n\n> Check pycyphal/yakut/yukon docs for additional details\n\n</details>\n\n## 2. LINUX PREPARATION (SOCKETCAN)\n\nBy default, DroneCAN and Cyphal/CAN uses cross-platform transport interface [Python-CAN](https://python-can.readthedocs.io/en/stable/) [CAN over Serial / SLCAN](https://python-can.readthedocs.io/en/stable/interfaces/slcan.html).\n\nOn Linux, [the socketcan interface](https://python-can.readthedocs.io/en/stable/interfaces/socketcan.html) is recommended. Unlike SLCAN, socketcan interface allows to share the same CAN interface with multiple processes, so you can run a few pycyphal scripts, yukon, yakut simultaniously.\n\nYou can run the following script:\n\n```bash\n./scripts/socketcan.sh\n```\n\nFor a Cyphal application after creating socketcan interface, you need to update `UAVCAN__CAN__IFACE` environment variable. Just call `source ~/.bashrc`.\n\n## 3. USAGE\n\n### 1. Test cyphal specification\n\n```bash\nrl-test-cyphal-specification\n```\n\n\n\n### 2. Test dronecan specification\n\n```bash\nrl-test-dronecan-specification\n```\n\n```bash\nrl-test-dronecan-gps-mag-baro\n```\n\n\n\n\n### 3. Get Node Info (Cyphal / DroneCAN)\n\n```bash\nrl-get-info\n```\n\nReturn:\n- Online CAN-sniffers\n- Detect protocol if any CAN-node is avaliable: cyphal | dronecan | none\n- Show node info of Cyphal/CAN or DroneCAN node if it is avaliable\n\n### 4. Upload firmware with st-link linux / STM32CubeProgrammer Windows\n\n```bash\nrl-upload-firmware --config PATH_TO_YAML_CONFIG\n```\n\n```bash\nrl-upload-firmware --binary PATH_TO_BIN_FILE\n```\n\nThere are a few ways how you can specify the path to the binary:\n\n1. (recommended) Using a GitHub Repository. It will always download the latest released firmware.\n\n```yaml\n# config.yaml\nmetadata:\n link: RaccoonlabDev/mini_v2_node\n```\n\n2. Direct Link to the Firmware File\n\n```yaml\n# config.yaml\nmetadata:\n link: https://github.com/RaccoonlabDev/docs/releases/download/v1.6.5/gnss_v2_cyphal_v1.6.5_c78d47c3.bin\n```\n\n3. Using a Local Path\n\n```yaml\n# config.yaml\nmetadata:\n link: /user/home/firmwares/node.bin\n```\n\n4. Direct .bin path with `--binary` option\n\n### 5. Upload config\n\n```bash\nrl-config --config PATH\n```\n\nExample of yaml config file:\n\n```yaml\n# config.yaml\nparams:\n uavcan.node_id: 31\n uavcan.node.name: co.rl.mini\n```\n\n\n\n\n### 6. Monitor\n\n```bash\nrl-monitor\n```\n\nThis script is used for automated node analysis. Within a single command:\n- detect the protocol (Cyphal or DroneCAN),\n- detect the node type,\n- check the software version and highlight if it is not the latest,\n- configure it if it has not been configured yet,\n- subscribes on all possible topics,\n- provide basic tests and diagnostics, highlight issues,\n- publish some test commands if possible,\n- print all data in real time.\n\nAn example of `rl-monitor` with gnss node:\n\n\n\n### 7. U-center with Cyphal GNSS\n\n```bash\nrl-ublox-center\n```\n\nFor RL GNSS it is possible to run u-center over Cyphal via `gps.ubx_tx` and `gps.ubx_rx` topics.\n\n1. Download [u-center](https://www.u-blox.com/en/product/u-center) (tested with u-center 23.08)\n2. Run the u-center. On ubuntu you can use wine (`wine64 u-centersetup_v23.08/u-center_v23.08.exe`)\n3. Configure the Cyphal environment\n4. Run the script `rl-ublox-center`\n5. Press Receiver - > Connection -> Network connection\n6. Add new connection `tcp://127.0.0.1:2001`\n\nAn illustration:\n\n\n\n\n\n<!--\n\n### 6. Upload cyphal parameters\n\n### UC7-8. Check cyphal/dronecan node type by name\n\nrl-give-node-type\n\n### UC9. Check RL firmware version\n\nrl-check-updates\n\n### UC10. Check other (custom) vendors firmware version\n\n...\n\n### UC11-12. Create socketcan linux (real/virtual)\n\nrl-socketcan\n\n### UC13-14. Create slcan linux/windows -->\n\n## 4. DEVELOPER NOTES\n\nDeploy to [TestPyPI](https://test.pypi.org/project/raccoonlab-tools/):\n\n```bash\n./scripts/deploy.sh\n```\n\nDeploy to [PyPI](https://pypi.org/project/raccoonlab-tools/):\n\n```bash\n./scripts/deploy.sh --pypi\n```\n\n## 5. USAGE TERMS\n\nThe scripts are distributed under MIT license. In general, you can do with them whatever you want. If you find a bug, please suggest a PR or an issue.\n",
"bugtrack_url": null,
"license": null,
"summary": "RaccoonLab tools",
"version": "0.0.18",
"project_urls": {
"Bug Tracker": "https://github.com/PonomarevDA/tools/issues",
"Homepage": "https://github.com/PonomarevDA/tools"
},
"split_keywords": [
"cyphal",
" dronecan",
" can"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "de9731af65eeaec51784dfbf60d4b8ceb50c13b0d1d938ec8e42983c2e070b1b",
"md5": "f16db58e0745d6e291801622a6e207eb",
"sha256": "55a96acd6ef9493af0f1a887a0dbcac65400d3136f87a9cce0c5470b25cc5968"
},
"downloads": -1,
"filename": "raccoonlab_tools-0.0.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f16db58e0745d6e291801622a6e207eb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 52924,
"upload_time": "2024-03-31T10:27:35",
"upload_time_iso_8601": "2024-03-31T10:27:35.671884Z",
"url": "https://files.pythonhosted.org/packages/de/97/31af65eeaec51784dfbf60d4b8ceb50c13b0d1d938ec8e42983c2e070b1b/raccoonlab_tools-0.0.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "678f6df7020b63a98be3832ece59f865c63fde66c06be8b55baf3689f0df3bf2",
"md5": "1e003c4f48462f0c5b31b74e90a07a1b",
"sha256": "46b318d0ce4e077c477023a1be562c92b25cd71494da9f6c7369019ed234854a"
},
"downloads": -1,
"filename": "raccoonlab-tools-0.0.18.tar.gz",
"has_sig": false,
"md5_digest": "1e003c4f48462f0c5b31b74e90a07a1b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 38451,
"upload_time": "2024-03-31T10:27:37",
"upload_time_iso_8601": "2024-03-31T10:27:37.716849Z",
"url": "https://files.pythonhosted.org/packages/67/8f/6df7020b63a98be3832ece59f865c63fde66c06be8b55baf3689f0df3bf2/raccoonlab-tools-0.0.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-31 10:27:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PonomarevDA",
"github_project": "tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "raccoonlab-tools"
}
