https://github.com/tfeldmann/supersigma2-errorcodes
A python parser for DMC SuperSigma2 error codes
https://github.com/tfeldmann/supersigma2-errorcodes
Last synced: over 1 year ago
JSON representation
A python parser for DMC SuperSigma2 error codes
- Host: GitHub
- URL: https://github.com/tfeldmann/supersigma2-errorcodes
- Owner: tfeldmann
- License: gpl-3.0
- Created: 2021-07-06T09:21:23.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-07T14:37:00.000Z (about 5 years ago)
- Last Synced: 2025-02-01T12:09:16.743Z (over 1 year ago)
- Language: Python
- Size: 33.2 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# supersigma2-errorcodes
A python parser for DMC SuperSigma2 error codes.
## Installation
Needs Python >= 3.6.
Install using `pip`:
```
pip install supersigma2-errorcodes
```
If you only need the standalone `sigma`-script to parse error codes in the command line,
it is recommended to use `pipx` for the installation:
```
pipx install supersigma2-errorcodes
```
## Command line usage
A `sigma` command line script is installed by pip which can be used like this:
```shell
$ sigma 13.2 18.3 19.2
[13.2] Accelerator more than 50% at power up: Wig-wag high at power up
[18.3] High sided mosfets short circuit: M3 mosfets
[19] Motor stall protection
```
If no error codes are given, the usage is interactive.
## Library usage
```python
from sigma import code_to_string
code_to_string("12.2")
>>> "[12.2] Power up sequence fault: Traction: Forward switch active at power up"
code_to_string("18.3", include_code=False)
>>> "High sided mosfets short circuit: M3 mosfets"
```