| Name | oresat-cfc JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | OreSat CFC OLAF app |
| upload_time | 2024-05-19 18:28:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | GPL-3.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# OreSat CFC Software
Software for Linux version of the CFC (Cirrus Flux Camera) card.
Like all OreSat software projects it is built using OLAF (OreSat Linux App
Framework), which it built ontop of [CANopen for Python]. See the
[oresat-olaf repo] for more info about OLAF.
When this project is running on the real hardware it will required the
`prucam-pirt1280` kernel module.
See https://github.com/oresat/oresat-prucam-pirt1280 for more info.
## Quickstart
Install dependenies
```bash
$ pip3 install -r requirements.txt
```
Make a virtual CAN bus
```bash
$ sudo ip link add dev vcan0 type vcan
$ sudo ip link set vcan0 up
```
Run the CFC app
```bash
$ python3 -m oresat_cfc
```
Can select the CAN bus to use (`vcan0`, `can0`, etc) with the `-b BUS` arg.
Can mock hardware by using the `-m HARDWARE` flag.
- The`-m all` flag can be used to mock all hardware (CAN bus is always
required).
- The `-m camera` flag would only mock the camera
- The `-m tec` flag would only mock the TEC
See other options with `-h` flag.
A basic [Flask]-based website for development and integration can be found at
`http://localhost:8000` when the software is running.
[Flask]: https://flask.palletsprojects.com/en/latest/
[oresat-olaf repo]: https://github.com/oresat/oresat-olaf
[CANopen for Python]: https://github.com/christiansandberg/canopen
Raw data
{
"_id": null,
"home_page": null,
"name": "oresat-cfc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/36/08/e6317630e442e63911ad516f00091cc4a86a165e5c0f4d7253b51713f1e4/oresat_cfc-0.1.1.tar.gz",
"platform": null,
"description": "# OreSat CFC Software\n\nSoftware for Linux version of the CFC (Cirrus Flux Camera) card.\n\nLike all OreSat software projects it is built using OLAF (OreSat Linux App\nFramework), which it built ontop of [CANopen for Python]. See the\n[oresat-olaf repo] for more info about OLAF.\n\nWhen this project is running on the real hardware it will required the\n`prucam-pirt1280` kernel module.\nSee https://github.com/oresat/oresat-prucam-pirt1280 for more info.\n\n## Quickstart\n\nInstall dependenies\n\n```bash\n$ pip3 install -r requirements.txt\n```\nMake a virtual CAN bus\n\n```bash\n$ sudo ip link add dev vcan0 type vcan\n$ sudo ip link set vcan0 up\n```\n\nRun the CFC app\n\n```bash\n$ python3 -m oresat_cfc\n```\n\nCan select the CAN bus to use (`vcan0`, `can0`, etc) with the `-b BUS` arg.\n\nCan mock hardware by using the `-m HARDWARE` flag.\n\n- The`-m all` flag can be used to mock all hardware (CAN bus is always\nrequired).\n- The `-m camera` flag would only mock the camera\n- The `-m tec` flag would only mock the TEC\n\nSee other options with `-h` flag.\n\nA basic [Flask]-based website for development and integration can be found at\n`http://localhost:8000` when the software is running.\n\n[Flask]: https://flask.palletsprojects.com/en/latest/\n[oresat-olaf repo]: https://github.com/oresat/oresat-olaf\n[CANopen for Python]: https://github.com/christiansandberg/canopen\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "OreSat CFC OLAF app",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0f4593e761a76fe4cefe42746d92f0d5db089b12d9cc6e48d16c693ad56f07a6",
"md5": "45d1c4b2d78012e08a1fe799006d4eda",
"sha256": "2d593464ea7d534997d0dd180a08c28d2457f212e1d0728621cf8108853e7329"
},
"downloads": -1,
"filename": "oresat_cfc-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "45d1c4b2d78012e08a1fe799006d4eda",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 31790,
"upload_time": "2024-05-19T18:28:05",
"upload_time_iso_8601": "2024-05-19T18:28:05.255826Z",
"url": "https://files.pythonhosted.org/packages/0f/45/93e761a76fe4cefe42746d92f0d5db089b12d9cc6e48d16c693ad56f07a6/oresat_cfc-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3608e6317630e442e63911ad516f00091cc4a86a165e5c0f4d7253b51713f1e4",
"md5": "e070445a9865cbf02ae980165254671e",
"sha256": "6c2fb55a8df37b4bc908dedda3aa050a8aff3eac9f286fba157e6d1179c21115"
},
"downloads": -1,
"filename": "oresat_cfc-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "e070445a9865cbf02ae980165254671e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 30483,
"upload_time": "2024-05-19T18:28:06",
"upload_time_iso_8601": "2024-05-19T18:28:06.391414Z",
"url": "https://files.pythonhosted.org/packages/36/08/e6317630e442e63911ad516f00091cc4a86a165e5c0f4d7253b51713f1e4/oresat_cfc-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-19 18:28:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "oresat-cfc"
}
