ekfsm 0.11.0b1.post3__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of ekfsm might be problematic. Click here for more details.

Files changed (39) hide show
  1. ekfsm/__init__.py +13 -0
  2. ekfsm/boards/oem/ekf/ccu.yaml +68 -0
  3. ekfsm/boards/oem/ekf/sc5-festival.yaml +30 -0
  4. ekfsm/boards/oem/ekf/sc9-toccata.yaml +31 -0
  5. ekfsm/boards/oem/ekf/spv-mystic.yaml +68 -0
  6. ekfsm/boards/oem/ekf/sq1-track.yaml +41 -0
  7. ekfsm/boards/oem/ekf/srf-fan.yaml +48 -0
  8. ekfsm/boards/oem/ekf/sur-uart.yaml +72 -0
  9. ekfsm/boards/oem/hitron/hdrc-300.yaml +20 -0
  10. ekfsm/cli.py +111 -0
  11. ekfsm/config.py +37 -0
  12. ekfsm/core/__init__.py +4 -0
  13. ekfsm/core/components.py +120 -0
  14. ekfsm/core/probe.py +10 -0
  15. ekfsm/core/slots.py +201 -0
  16. ekfsm/core/sysfs.py +91 -0
  17. ekfsm/core/utils.py +77 -0
  18. ekfsm/devices/__init__.py +28 -0
  19. ekfsm/devices/eeprom.py +1054 -0
  20. ekfsm/devices/ekf_ccu_uc.py +390 -0
  21. ekfsm/devices/ekf_sur_led.py +67 -0
  22. ekfsm/devices/generic.py +245 -0
  23. ekfsm/devices/gpio.py +340 -0
  24. ekfsm/devices/hwmon.py +71 -0
  25. ekfsm/devices/iio.py +58 -0
  26. ekfsm/devices/iio_thermal_humidity.py +41 -0
  27. ekfsm/devices/mux.py +39 -0
  28. ekfsm/devices/pmbus.py +65 -0
  29. ekfsm/devices/smbios.py +38 -0
  30. ekfsm/devices/utils.py +16 -0
  31. ekfsm/exceptions.py +58 -0
  32. ekfsm/log.py +28 -0
  33. ekfsm/py.typed +2 -0
  34. ekfsm/simctrl.py +241 -0
  35. ekfsm/system.py +326 -0
  36. ekfsm-0.11.0b1.post3.dist-info/METADATA +86 -0
  37. ekfsm-0.11.0b1.post3.dist-info/RECORD +39 -0
  38. ekfsm-0.11.0b1.post3.dist-info/WHEEL +4 -0
  39. ekfsm-0.11.0b1.post3.dist-info/entry_points.txt +2 -0
ekfsm-0.11.0b1.post3.dist-info/METADATA ADDED
@@ -0,0 +1,86 @@
1
+ Metadata-Version: 2.4
2
+ Name: ekfsm
3
+ Version: 0.11.0b1.post3
4
+ Summary: The EKF System Management Library (ekfsm) is a sensor monitoring suite for Compact PCI Serial devices.
5
+ Author-email: Klaus Popp <klaus.popp@ci4rail.com>, Jan Jansen <jan@ekf.de>, Felix Päßler <fp@ekf.de>
6
+ Requires-Python: >=3.10
7
+ Requires-Dist: anytree
8
+ Requires-Dist: click>=8.0.1
9
+ Requires-Dist: crcmod
10
+ Requires-Dist: gpiod>=2.1.0
11
+ Requires-Dist: hexdump
12
+ Requires-Dist: more-itertools
13
+ Requires-Dist: munch
14
+ Requires-Dist: smbus2
15
+ Requires-Dist: types-pyyaml>=6.0.12.20241230
16
+ Requires-Dist: yamale
17
+ Description-Content-Type: text/markdown
18
+
19
+ # ekfsm - EKF system management library
20
+
21
+ Provides access to system management functions on Linux based modular hardware systems,
22
+ such as CompactPCI-Serial systems.
23
+
24
+ Initial implementation for [DP-ZIP2 CompactPCI-Serial system](https://ekf.atlassian.net/l/cp/KzN2q7KR)
25
+
26
+ ## Features
27
+
28
+ - System configuration via YAML configuration file
29
+ - Obtain inventory information of the system and its components
30
+ - Obtain sensor information, such as temperature, humidity, voltage, current, accelerometer, gyroscope, etc.
31
+ - Access to system level functions, such as system LEDs, system fan, system power supply, etc.
32
+ - Supports simulation mode for development and testing
33
+
34
+ ## Packaging
35
+
36
+ The project can be packaged and deployed as a pypi package to the gitlab pypi registry.
37
+
38
+ The project metadata is partially generated dynamically from the project readme and the auto generated version tag from SCM.
39
+
40
+ ### Build the package
41
+
42
+ To build the package run `make build`
43
+
44
+ ### Upload package manually to the GITLAB package registry
45
+
46
+ 1. Set up your authentication method and the project URL in your `~/.pypirc` according to [Authenticate with the package registry](https://gitlab.ekf.com/api/v4/projects/407/packages/pypi)
47
+ 2. Run `make upload`
48
+
49
+ Note that the version string which is generated complies to the `setuptools-scm` default versioning scheme and thus the version string will be slightly different from the string generated during the pipeline build if running from a shell in a workspace.
50
+
51
+ *See also [SetupTools-SCM Documentation](https://setuptools-scm.readthedocs.io/en/latest/) and [SetupTool UserGuide](https://setuptools.pypa.io/en/latest/userguide).*
52
+
53
+ ## Install a package
54
+
55
+ See instructions given in the packages deployed under [this projects pypi registry](https://gitlab.ekf.com/libs/apis/ekfsm/-/packages/).
56
+
57
+ ## Generating documentation
58
+
59
+ From the nix shell, run `make docs` to generate the documentation. This will start a local web server to view the generated documentation. It is automatically updated when the source code changes.
60
+
61
+ The documentation is generated using the `sphinx` tool. The configuration and docs are stored in the `docs` folder.
62
+
63
+
64
+ ## Remote development on the target
65
+
66
+ On the remote machine, install recent version of direnv:
67
+
68
+ ```bash
69
+ curl -sfL https://direnv.net/install.sh | bash
70
+ ```
71
+
72
+ Add the following line to your ~/.bashrc or ~/.bash_profile:
73
+
74
+ ```bash
75
+ eval "$(direnv hook bash)"
76
+ ```
77
+
78
+ Install the following extensions in VSCode:
79
+ * cab404.vscode-direnv
80
+ * ms-python.mypy-type-checker
81
+ * mikoz.black-py
82
+ * ms-python.python
83
+ * ms-python.vscode-pylance
84
+ * ms-python.debugpy
85
+
86
+ From vscode on the host machine, open the project folder on the remote machine via ssh. The direnv extension will automatically load the environment variables from the `.envrc` file.
ekfsm-0.11.0b1.post3.dist-info/RECORD ADDED
@@ -0,0 +1,39 @@
1
+ ekfsm/__init__.py,sha256=RF5mSVhkFWVsbJgYk-qMKb9eVHAcQ7WbJCunGBim4Ig,244
2
+ ekfsm/cli.py,sha256=HJuqHtaa0RH2m-1yk5J9d2gQ8ybjVf7FdIzLcBssacA,2743
3
+ ekfsm/config.py,sha256=mBWfPeD7U3Zh9qPwLVC_mfykGI6lxZ4mJcV8Vf3PI_0,890
4
+ ekfsm/exceptions.py,sha256=25P677GxfBTdBWHRngPce0bmhcLg7MFeTtuAvguxd90,1310
5
+ ekfsm/log.py,sha256=_GC8Y7a4fFV4_DNicbwQ-5rRzNQU6WSotXd2etXSrZk,866
6
+ ekfsm/py.typed,sha256=1gNRtmxvYcVqDDEyAzBLnD8dAOweUfYxW2ZPdJzN1fg,102
7
+ ekfsm/simctrl.py,sha256=dD7pO7EBTiWwSP8ZrGf9-H69g4yDQE3hGtQn5Y3MR1w,7002
8
+ ekfsm/system.py,sha256=_4jkaoikSY5SbHtrzuwiAInE9EnorDh1IampC5v-gHw,10732
9
+ ekfsm/boards/oem/ekf/ccu.yaml,sha256=WgENJDHBYFgUoiYxl4DNv5f6Mz_5oMA-cyD0y1aHvkg,2034
10
+ ekfsm/boards/oem/ekf/sc5-festival.yaml,sha256=_0kS5GegfyOt5CTJc9kY6HJbr9yZo4i18sVo6F4KE9c,772
11
+ ekfsm/boards/oem/ekf/sc9-toccata.yaml,sha256=btLgQMSsW0tRipnUYUkVQSIsjzxfKq0NXaQ1fMMyBRI,771
12
+ ekfsm/boards/oem/ekf/spv-mystic.yaml,sha256=zcLiNE7wVdXIT4vkwEYSqQ8ff-KEjCHfHnQzzPXJQ4E,1804
13
+ ekfsm/boards/oem/ekf/sq1-track.yaml,sha256=YU83BQjGu-4ejirwnGxd38sJme859kdRovkZyiOJciU,1050
14
+ ekfsm/boards/oem/ekf/srf-fan.yaml,sha256=Mcu1Q8B1Ih10hoc_hbkGlppBmbOFcufsVUR42iW4Rwc,1368
15
+ ekfsm/boards/oem/ekf/sur-uart.yaml,sha256=VaNP2BSlNTi1lDco16Ma9smPEAMaVKvx-ZNDcm3QptM,1890
16
+ ekfsm/boards/oem/hitron/hdrc-300.yaml,sha256=juRO3ahLNNqCH099-QJGQRWRh5qg-brAob0maJ0R5tY,427
17
+ ekfsm/core/__init__.py,sha256=nv3Rs-E953M9PBFV9ryejRY-KM6xG1NMlQTWwzCEQwo,212
18
+ ekfsm/core/components.py,sha256=yCHU88DF4ECjzHiJ9ofg_ic7oX6dm3ACIbV7Ve6At_o,3558
19
+ ekfsm/core/probe.py,sha256=DgJvkvMjVk09n0Rzn13ybRvidrmFn_D2PD56XS-KgxU,262
20
+ ekfsm/core/slots.py,sha256=WOKYO-8TfpWexu3DsSjrYTvjtN4pAMiy22zMjjUI-qQ,6569
21
+ ekfsm/core/sysfs.py,sha256=iW_XWtEjW7pZqpJc_RyMzhVjbetw0ydTH11lhfxrPbc,2541
22
+ ekfsm/core/utils.py,sha256=RYX-rd0pBBXvwjyInDFD8BKZppIBvln9sT4o4kRRcMk,2504
23
+ ekfsm/devices/__init__.py,sha256=h3pE3yPnquTIykpi7yxoTJOJ8YfVh_PqGiFMJGpXdCs,888
24
+ ekfsm/devices/eeprom.py,sha256=ubeext9PC6FDQ1qoaYZp3ZNRlEhPYBzTe1oXJdm4qtU,31029
25
+ ekfsm/devices/ekf_ccu_uc.py,sha256=H5nt51cu8oTPos-SYmoDvVioG4QoFs11XX7LiUySLwQ,12796
26
+ ekfsm/devices/ekf_sur_led.py,sha256=KPr75RVQQKEUWj5gP0ciSJam9jWniG1ew3k_62onwrE,1887
27
+ ekfsm/devices/generic.py,sha256=LuNpf0sn-TwZ1nkJc3Shu4-07mAhQIc6-CJwu7cNZwc,9273
28
+ ekfsm/devices/gpio.py,sha256=6ofOlOm7toAHb7J2FSYqs0Wu8lhShCHDAWA0rhsZJLI,9510
29
+ ekfsm/devices/hwmon.py,sha256=EXBFTE6QfhpA-Xb7CnhlR_fVGIjw5tWt3JzrtkXKGic,1987
30
+ ekfsm/devices/iio.py,sha256=gMOJGdg2PvFbAvlBpLfDTIc_-9i1Z3OLpuabTke6N3I,1480
31
+ ekfsm/devices/iio_thermal_humidity.py,sha256=YjXHI2AXSDpAuAGHYc_Kk7wMO9LGimHSXnARw4rxYJ0,1212
32
+ ekfsm/devices/mux.py,sha256=mFd0Tr5XQp6MIMNV1xpsQETrELWkvx1ZTSAemiUasoU,1042
33
+ ekfsm/devices/pmbus.py,sha256=Zf3JfMX1VTmmU2hoZkqOR9UTZcNRvnbqhhOlZ4sdoX4,2033
34
+ ekfsm/devices/smbios.py,sha256=KC1D2dSRaertYLeMFF6C9hQUI_RcTzVdtQ1qh8Hbces,985
35
+ ekfsm/devices/utils.py,sha256=4-0Kmvy4ou8R71afNj6RqdBTjLW4SMWPHqVrzB2RUZw,397
36
+ ekfsm-0.11.0b1.post3.dist-info/METADATA,sha256=9gZmLcYKM0u-vjRTMXY9Fi6NzMssPZUpoD6CJZbyyOQ,3370
37
+ ekfsm-0.11.0b1.post3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
38
+ ekfsm-0.11.0b1.post3.dist-info/entry_points.txt,sha256=WhUR4FzuxPoGrbTOKLsNJO7NAnk2qd4T30fqzN1yLw8,45
39
+ ekfsm-0.11.0b1.post3.dist-info/RECORD,,
ekfsm-0.11.0b1.post3.dist-info/WHEEL ADDED
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.27.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
ekfsm-0.11.0b1.post3.dist-info/entry_points.txt ADDED
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ ekfsm-cli = ekfsm.cli:main