| Name | lannerpsp JSON |
| Version |
0.0.12
JSON |
| download |
| home_page | |
| Summary | Python API for Lanner PSP |
| upload_time | 2023-02-08 08:28:07 |
| maintainer | |
| docs_url | None |
| author | UFO Chen |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2023 Lanner Electronics Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
lanner
psp
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
=========================
Python API for Lanner PSP
=========================
.. image:: https://badge.fury.io/py/lannerpsp.svg
:target: https://badge.fury.io/py/lannerpsp
:alt: PyPI version
.. image:: https://img.shields.io/pypi/l/lannerpsp
:target: https://opensource.org/licenses/MIT
:alt: License: MIT
.. image:: https://static.pepy.tech/badge/lannerpsp
:target: https://pepy.tech/project/lannerpsp
:alt: Total downloads
.. image:: https://img.shields.io/pypi/pyversions/lannerpsp
:target: https://www.python.org/
:alt: Python version
A Python interface to access `Lanner PSP`_.
About
=====
`Lanner PSP`_ aims to simplify and enhance the efficiency of customer’s application implementation.
When developers intend to write an application that involves hardware access, they were required
to fully understand the specifications to utilize the drivers. This is often being considered a time-
consuming job which requires lots of related knowledge and time. In order to achieve better full
access hardware functionality, `Lanner`_ invests great effort to ease customer’s development journey
with the release of a suite of reliable Software APIs.
"Python API for Lanner PSP" uses Python to call the shared object file generated after PSP compilation
to execute PSP functions, and encapsulates many C functions in PSP into Python interfaces, so please
make sure to install `Core SDK`_ before use.
If your `Core SDK`_ was installed via the `One-Step Automated Install`_ method, you can use it out of
the box, otherwise you should set the ``liblmbio.so`` and ``liblmbapi.so`` paths before instantiating
other objects. For example:
.. code:: python
from lannerpsp import PSP, HWM
PSP.lmb_io_path = "/path/to/liblmbio.so"
PSP.lmb_api_path = "/path/to/liblmbapi.so"
hwm = HWM()
hwm.get_cpu_temp(1)
...
Assuming you want to obtain the sensors data for the hardware monitor:
.. code:: python
from lannerpsp import HWM
hwm = HWM()
sensors = hwm.list_supported_sensors()
for s in sensors:
print(f"{s.display_name} = {s.value} {s.unit}")
Then run it with **ROOT** privileges, the output will be like:
.. code:: console
CPU 1 temperature = 41 C
SYS 1 temperature = 42 C
CPU 1 Vcore = 0.856 V
5V = 5.087 V
3.3V = 3.35 V
Battery = 3.184 V
DDR channel 1 = 1.104 V
For complete usage, please refer to the `documentation`_.
Concurrency and Parallelism
===========================
`Lanner PSP`_ invokes many underlying hardware interfaces for communication, such as IPMI, SMBus,
Super I/O, or some MCUs. Some PSP functions may occupy the same communication channel, such as UART
or I2C, etc. Please **avoid** using multi-process or multi-threading unless you can ensure they will
not cause errors due to simultaneous access to the same channel.
Installation
============
To use the "Python API for Lanner PSP", you must have **ROOT** privileges and the `Core SDK`_ must be
installed first. To install "Python API for Lanner PSP", see the `Installation`_ chapter.
Documentation
=============
Comprehensive documentation is available at https://psp-api-python.readthedocs.io/.
Issues and questions
====================
If you have a feature request or bug report, please open an `issue on GitHub`_.
If you have a question or need help, this may be better suited to `Lanner`_'s official online customer service.
Python support
==============
.. warning::
"Python API for Lanner PSP" only supports Python 3.6 and above.
.. _Lanner PSP: https://link.lannerinc.com/psp
.. _Lanner: https://lannerinc.com/
.. _Core SDK: https://github.com/lanneriotsw/psp-manager
.. _One-Step Automated Install: https://github.com/lanneriotsw/psp-manager#method-1-one-step-automated-install
.. _documentation: https://psp-api-python.readthedocs.io/
.. _Installation: https://psp-api-python.readthedocs.io/en/stable/installing.html
.. _issue on GitHub: https://github.com/lanneriotsw/psp-api-python/issues/new
Raw data
{
"_id": null,
"home_page": "",
"name": "lannerpsp",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "lanner,psp",
"author": "UFO Chen",
"author_email": "ufo_chen@lannerinc.com",
"download_url": "https://files.pythonhosted.org/packages/1a/78/73890d938f222994486cb692e37b6443910ee7ac1af201ef99f797af2605/lannerpsp-0.0.12.tar.gz",
"platform": "Linux",
"description": "=========================\nPython API for Lanner PSP\n=========================\n\n.. image:: https://badge.fury.io/py/lannerpsp.svg\n :target: https://badge.fury.io/py/lannerpsp\n :alt: PyPI version\n\n.. image:: https://img.shields.io/pypi/l/lannerpsp\n :target: https://opensource.org/licenses/MIT\n :alt: License: MIT\n\n.. image:: https://static.pepy.tech/badge/lannerpsp\n :target: https://pepy.tech/project/lannerpsp\n :alt: Total downloads\n\n.. image:: https://img.shields.io/pypi/pyversions/lannerpsp\n :target: https://www.python.org/\n :alt: Python version\n\nA Python interface to access `Lanner PSP`_.\n\nAbout\n=====\n\n`Lanner PSP`_ aims to simplify and enhance the efficiency of customer\u2019s application implementation.\nWhen developers intend to write an application that involves hardware access, they were required\nto fully understand the specifications to utilize the drivers. This is often being considered a time-\nconsuming job which requires lots of related knowledge and time. In order to achieve better full\naccess hardware functionality, `Lanner`_ invests great effort to ease customer\u2019s development journey\nwith the release of a suite of reliable Software APIs.\n\n\"Python API for Lanner PSP\" uses Python to call the shared object file generated after PSP compilation\nto execute PSP functions, and encapsulates many C functions in PSP into Python interfaces, so please\nmake sure to install `Core SDK`_ before use.\n\nIf your `Core SDK`_ was installed via the `One-Step Automated Install`_ method, you can use it out of\nthe box, otherwise you should set the ``liblmbio.so`` and ``liblmbapi.so`` paths before instantiating\nother objects. For example:\n\n.. code:: python\n\n from lannerpsp import PSP, HWM\n\n PSP.lmb_io_path = \"/path/to/liblmbio.so\"\n PSP.lmb_api_path = \"/path/to/liblmbapi.so\"\n\n hwm = HWM()\n\n hwm.get_cpu_temp(1)\n ...\n\nAssuming you want to obtain the sensors data for the hardware monitor:\n\n.. code:: python\n\n from lannerpsp import HWM\n\n hwm = HWM()\n\n sensors = hwm.list_supported_sensors()\n for s in sensors:\n print(f\"{s.display_name} = {s.value} {s.unit}\")\n\nThen run it with **ROOT** privileges, the output will be like:\n\n.. code:: console\n\n CPU 1 temperature = 41 C\n SYS 1 temperature = 42 C\n CPU 1 Vcore = 0.856 V\n 5V = 5.087 V\n 3.3V = 3.35 V\n Battery = 3.184 V\n DDR channel 1 = 1.104 V\n\nFor complete usage, please refer to the `documentation`_.\n\nConcurrency and Parallelism\n===========================\n\n`Lanner PSP`_ invokes many underlying hardware interfaces for communication, such as IPMI, SMBus,\nSuper I/O, or some MCUs. Some PSP functions may occupy the same communication channel, such as UART\nor I2C, etc. Please **avoid** using multi-process or multi-threading unless you can ensure they will\nnot cause errors due to simultaneous access to the same channel.\n\nInstallation\n============\n\nTo use the \"Python API for Lanner PSP\", you must have **ROOT** privileges and the `Core SDK`_ must be\ninstalled first. To install \"Python API for Lanner PSP\", see the `Installation`_ chapter.\n\nDocumentation\n=============\n\nComprehensive documentation is available at https://psp-api-python.readthedocs.io/.\n\nIssues and questions\n====================\n\nIf you have a feature request or bug report, please open an `issue on GitHub`_.\nIf you have a question or need help, this may be better suited to `Lanner`_'s official online customer service.\n\nPython support\n==============\n\n.. warning::\n\n \"Python API for Lanner PSP\" only supports Python 3.6 and above.\n\n.. _Lanner PSP: https://link.lannerinc.com/psp\n.. _Lanner: https://lannerinc.com/\n.. _Core SDK: https://github.com/lanneriotsw/psp-manager\n.. _One-Step Automated Install: https://github.com/lanneriotsw/psp-manager#method-1-one-step-automated-install\n.. _documentation: https://psp-api-python.readthedocs.io/\n.. _Installation: https://psp-api-python.readthedocs.io/en/stable/installing.html\n.. _issue on GitHub: https://github.com/lanneriotsw/psp-api-python/issues/new\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Lanner Electronics Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Python API for Lanner PSP",
"version": "0.0.12",
"split_keywords": [
"lanner",
"psp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a107c76e054647e3a48c080f786b7eddbb443cbecdf5fae09193614dd8641801",
"md5": "9e8834de6943322cdc09ed2f4398980b",
"sha256": "d66f45eddeb6f4b13e0effd48d57795b343b23aecbdca7788ba8007e0b90cf9c"
},
"downloads": -1,
"filename": "lannerpsp-0.0.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e8834de6943322cdc09ed2f4398980b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 48197,
"upload_time": "2023-02-08T08:28:04",
"upload_time_iso_8601": "2023-02-08T08:28:04.155417Z",
"url": "https://files.pythonhosted.org/packages/a1/07/c76e054647e3a48c080f786b7eddbb443cbecdf5fae09193614dd8641801/lannerpsp-0.0.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1a7873890d938f222994486cb692e37b6443910ee7ac1af201ef99f797af2605",
"md5": "1169c193530c68ec477dc31a0be88d48",
"sha256": "21f8e1987d066bc264c64fac6af8e5ba0ff401756f4de8c2d65ba70d9afb13b0"
},
"downloads": -1,
"filename": "lannerpsp-0.0.12.tar.gz",
"has_sig": false,
"md5_digest": "1169c193530c68ec477dc31a0be88d48",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 1107476,
"upload_time": "2023-02-08T08:28:07",
"upload_time_iso_8601": "2023-02-08T08:28:07.578115Z",
"url": "https://files.pythonhosted.org/packages/1a/78/73890d938f222994486cb692e37b6443910ee7ac1af201ef99f797af2605/lannerpsp-0.0.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-08 08:28:07",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "lannerpsp"
}
