# About [py_canoe](https://github.com/chaitu-ycr/py_canoe)
Python 🐍 Package for controlling Vector CANoe 🛶 Tool
fork [this repo](https://github.com/chaitu-ycr/py_canoe/fork) and create pull request to contribute back to this project.
for ideas/discussions please create new discussion [here](https://github.com/chaitu-ycr/py_canoe/discussions)
create issue or request feature [here](https://github.com/chaitu-ycr/py_canoe/issues/new/choose)
## GitHub Releases 👉 [link](https://github.com/chaitu-ycr/py_canoe/releases)
## PyPi Package 👉 [link](https://pypi.org/project/py_canoe/)
## Prerequisites [link](https://chaitu-ycr.github.io/py_canoe/002_prerequisites/)
## Python environment setup instructions [link](https://chaitu-ycr.github.io/py_canoe/003_environment_setup/)
## Install [py_canoe](https://pypi.org/project/py_canoe/) package
```bat
pip install py_canoe --upgrade
```
## Documentation Links
### example use cases 👉 [link](https://chaitu-ycr.github.io/py_canoe/004_usage/)
### package reference doc 👉 [link](https://chaitu-ycr.github.io/py_canoe/999_reference/)
## Sample Example
```python
# Import CANoe module
from py_canoe import CANoe
# create CANoe object
canoe_inst = CANoe()
# open CANoe configuration. Replace canoe_cfg with yours.
canoe_inst.open(canoe_cfg=r'tests\demo_cfg\demo.cfg')
# print installed CANoe application version
canoe_inst.get_canoe_version_info()
# Start CANoe measurement
canoe_inst.start_measurement()
# get signal value. Replace arguments with your message and signal data.
sig_val = canoe_inst.get_signal_value('CAN', 1, 'LightState', 'FlashLight')
print(sig_val)
# Stop CANoe Measurement
canoe_inst.stop_measurement()
# Quit / Close CANoe configuration
canoe_inst.quit()
```
Raw data
{
"_id": null,
"home_page": "https://github.com/chaitu-ycr/py_canoe.git",
"name": "py_canoe",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "Vector, CANoe, py_canoe",
"author": "chaitu-ycr",
"author_email": "chaitu.ycr@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9d/9b/b00b261c0b37f5f5d3745b5bd2b0491cbeb9e91ddede6c9a777addba0304/py_canoe-3.0.0.tar.gz",
"platform": null,
"description": "# About [py_canoe](https://github.com/chaitu-ycr/py_canoe)\n\nPython \ud83d\udc0d Package for controlling Vector CANoe \ud83d\udef6 Tool\n\nfork [this repo](https://github.com/chaitu-ycr/py_canoe/fork) and create pull request to contribute back to this project.\n\nfor ideas/discussions please create new discussion [here](https://github.com/chaitu-ycr/py_canoe/discussions)\n\ncreate issue or request feature [here](https://github.com/chaitu-ycr/py_canoe/issues/new/choose)\n\n## GitHub Releases \ud83d\udc49 [link](https://github.com/chaitu-ycr/py_canoe/releases)\n\n## PyPi Package \ud83d\udc49 [link](https://pypi.org/project/py_canoe/)\n\n## Prerequisites [link](https://chaitu-ycr.github.io/py_canoe/002_prerequisites/)\n\n## Python environment setup instructions [link](https://chaitu-ycr.github.io/py_canoe/003_environment_setup/)\n\n## Install [py_canoe](https://pypi.org/project/py_canoe/) package\n\n```bat\npip install py_canoe --upgrade\n```\n\n## Documentation Links\n\n### example use cases \ud83d\udc49 [link](https://chaitu-ycr.github.io/py_canoe/004_usage/)\n\n### package reference doc \ud83d\udc49 [link](https://chaitu-ycr.github.io/py_canoe/999_reference/)\n\n## Sample Example\n\n```python\n# Import CANoe module\nfrom py_canoe import CANoe\n\n# create CANoe object\ncanoe_inst = CANoe()\n\n# open CANoe configuration. Replace canoe_cfg with yours.\ncanoe_inst.open(canoe_cfg=r'tests\\demo_cfg\\demo.cfg')\n\n# print installed CANoe application version\ncanoe_inst.get_canoe_version_info()\n\n# Start CANoe measurement\ncanoe_inst.start_measurement()\n\n# get signal value. Replace arguments with your message and signal data.\nsig_val = canoe_inst.get_signal_value('CAN', 1, 'LightState', 'FlashLight')\nprint(sig_val)\n\n# Stop CANoe Measurement\ncanoe_inst.stop_measurement()\n\n# Quit / Close CANoe configuration\ncanoe_inst.quit()\n```\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "Python CANoe Package",
"version": "3.0.0",
"project_urls": {
"Documentation": "https://chaitu-ycr.github.io/py_canoe/",
"Homepage": "https://github.com/chaitu-ycr/py_canoe.git",
"Repository": "https://github.com/chaitu-ycr/py_canoe.git"
},
"split_keywords": [
"vector",
" canoe",
" py_canoe"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "426beda14f5de3ce571b5367eb6de3e046cc3507ca8c46ee941a76e23e08bc7a",
"md5": "5e73f31f0ff9945e2d09cf72e276c563",
"sha256": "12aaa6579ac3bb5ea416f62f8c3c83cc41a610f69cc5945b302669f20c5b5816"
},
"downloads": -1,
"filename": "py_canoe-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e73f31f0ff9945e2d09cf72e276c563",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 19568,
"upload_time": "2024-11-02T06:29:09",
"upload_time_iso_8601": "2024-11-02T06:29:09.283473Z",
"url": "https://files.pythonhosted.org/packages/42/6b/eda14f5de3ce571b5367eb6de3e046cc3507ca8c46ee941a76e23e08bc7a/py_canoe-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9d9bb00b261c0b37f5f5d3745b5bd2b0491cbeb9e91ddede6c9a777addba0304",
"md5": "b304499d168564ce75498ca5fda9e518",
"sha256": "57917f518ab77661d93eb39539986f9f027066f2a1fb13ced43a9cc908e1e6ba"
},
"downloads": -1,
"filename": "py_canoe-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "b304499d168564ce75498ca5fda9e518",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 19099,
"upload_time": "2024-11-02T06:29:10",
"upload_time_iso_8601": "2024-11-02T06:29:10.853241Z",
"url": "https://files.pythonhosted.org/packages/9d/9b/b00b261c0b37f5f5d3745b5bd2b0491cbeb9e91ddede6c9a777addba0304/py_canoe-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-02 06:29:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chaitu-ycr",
"github_project": "py_canoe",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "py_canoe"
}
JSON
