PiHardwareInfo 0.5.0__py3-none-any.whl

PiHardwareInfo-0.5.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Rex Zhang
+
+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.

PiHardwareInfo-0.5.0.dist-info/METADATA

@@ -0,0 +1,104 @@
+Metadata-Version: 2.2
+Name: PiHardwareInfo
+Version: 0.5.0
+Summary: Get Raspberry Pi hardware info
+Author: Rex Zhang
+Author-email: rex.zhang@gmail.com
+License: MIT
+Project-URL: repository, https://github.com/rexzhang/pi-hardware-info
+Keywords: raspberrypi
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# PiHardwareInfo
+
+[![image](https://img.shields.io/pypi/v/PiHardwareInfo.svg)](https://pypi.org/project/PiHardwareInfo/)
+[![image](https://img.shields.io/pypi/pyversions/PiHardwareInfo.svg)](https://pypi.org/project/PiHardwareInfo/)
+[![image](https://img.shields.io/pypi/dm/PiHardwareInfo.svg)](https://pypi.org/project/PiHardwareInfo/)
+
+Get Raspberry Pi hardware/version info from /proc/cpuinfo
+
+## Try
+
+run
+
+```console
+curl -s https://raw.githubusercontent.com/rexzhang/pi-hardware-info/master/pi_hardware_info.py | python3
+```
+
+result
+
+```console
+PiHardwareInfo(revision_code='d04170', model_type=<ModelType.RPI_5: 23>, processor=<Processor.BCM2712: 4>, memory=8192, revision='1.0', serial_number='ecc0679911343e07', model_name='Raspberry Pi 5 Model B Rev 1.0', overvoltage=False, otp_program=False, otp_read=False, manufacturer=<Manufacturer.SONY_UK: 0>)
+```
+
+## Install
+
+```console
+pip install PiHardwareInfo
+```
+
+## Usage as library
+
+```python
+from pi_hardware_info import ModelType, get_info
+
+info = get_info()
+if info.model_type == ModelType.MODEL_3B_PLUS:
+    print('5G Wifi ready')
+
+elif info.model_type == ModelType.MODEL_3B:
+    print('only 2.4G Wifi')
+```
+
+## Usage as tool
+
+```shell
+python -m pi_hardware_info
+```
+
+## History
+
+### 0.5.0
+
+- Add, Support to raspberry pi 5
+- Codebase modernization Updates
+  - Drop py3.5 py3.6 py3.7 py3.8
+  - Add type hints
+  - Add unit test
+  - Add pyproject.toml
+  - Add pre-commit
+
+### 0.4.0
+
+- Add, support Zero2W/400/CM4
+- Add, Overvoltage/OTP Program/OTP Read support
+
+### 0.3.3
+
+- Support raspberry pi 4B
+- Rewrite some code
+
+### 0.2.0
+
+- Add old style revision code support, support 1A/1B
+
+### 0.1.0
+
+- First release
+
+## Alternative
+
+- <https://github.com/tompreston/raspi-version>
+- <https://pypi.org/project/pirev>
+- <https://pypi.org/project/RPi.version>
+
+## Ref
+
+- <https://www.raspberrypi.com/documentation/computers/raspberry-pi.html>
+- <https://www.raspberrypi.com/documentation/computers/raspberry-pi.html#raspberry-pi-revision-codes>

PiHardwareInfo-0.5.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+pi_hardware_info.py,sha256=EBiQcvB4NQFVhipX7PxQIh6Y73H18-HBWET8pR6V94Q,4986
+PiHardwareInfo-0.5.0.dist-info/LICENSE,sha256=fGRFCl6JPYZa1XDp1afRCCutZggXR5E8AwljwpEaK3g,1066
+PiHardwareInfo-0.5.0.dist-info/METADATA,sha256=FQYcnmR-BF3mdSljKuu4X_WSOmKuQ6eoPy0VuMqppY0,2562
+PiHardwareInfo-0.5.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+PiHardwareInfo-0.5.0.dist-info/top_level.txt,sha256=Zma3_8OrsU5_esnO0EvYwsGZW9j9myNKjgk5uH8-uDI,17
+PiHardwareInfo-0.5.0.dist-info/RECORD,,

PiHardwareInfo-0.5.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

PiHardwareInfo-0.5.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pi_hardware_info

pi_hardware_info.py

@@ -0,0 +1,192 @@
+"""
+Get Raspberry Pi hardware info
+"""
+
+import re
+from dataclasses import dataclass
+from enum import Enum
+from logging import getLogger
+
+__version__ = "0.5.0"
+
+__author__ = "Rex Zhang"
+__author_email__ = "rex.zhang@gmail.com"
+__licence__ = "MIT"
+
+__description__ = "Get Raspberry Pi hardware info"
+__project_url__ = "https://github.com/rexzhang/pi-hardware-info"
+
+
+logger = getLogger(__file__)
+
+_memory = [256, 512, 1024, 2048, 4096, 8192, 16384]
+
+
+class Manufacturer(Enum):
+    UNKNOWN = -100
+
+    QISDA = -10
+
+    SONY_UK = 0
+    EGOMAN = 1
+    EMBEST = 2
+    SONY_JAPAN = 3
+    EMBEST2 = 4
+    STADIUM = 5
+
+
+class Processor(Enum):
+    UNKNOWN = -100
+
+    BCM2835 = 0
+    BCM2836 = 1
+    BCM2837 = 2
+    BCM2711 = 3
+    BCM2712 = 4
+
+
+class ModelType(Enum):
+    UNKNOWN = -100
+
+    RPI_A = 0
+    RPI_B = 1
+    RPI_A_PLUS = 2
+    RPI_B_PLUS = 3
+    RPI_2B = 4
+    RPI_ALPHA = 5
+    RPI_CM1 = 6
+    # 0x7 pass
+    RPI_3B = 8
+    RPI_ZERO = 9
+    RPI_CM3 = 0xA
+    # 0xb pass
+    RPI_ZERO_W = 0xC
+    RPI_3B_PLUS = 0xD
+    RPI_3A_PLUS = 0xE
+    # 0x0f: Internal use only
+    RPI_CM3_PLUS = 0x10
+    RPI_4B = 0x11
+    RPI_Zero2W = 0x12
+    RPI_400 = 0x13
+    RPI_CM4 = 0x14
+    RPI_CM4S = 0x15
+    # 0x16: Internal use only
+    RPI_5 = 0x17
+    RPI_CM5 = 0x18
+    RPI_CM5_LITE = 0x19
+
+
+_old_style = {
+    0x0000: (ModelType.UNKNOWN, "0.0", 0, Manufacturer.UNKNOWN),
+    0x0002: (ModelType.RPI_B, "1.0", 256, Manufacturer.EGOMAN),
+    0x0003: (ModelType.RPI_B, "1.0", 256, Manufacturer.EGOMAN),
+    0x0004: (ModelType.RPI_B, "2.0", 256, Manufacturer.SONY_UK),
+    0x0005: (ModelType.RPI_B, "2.0", 256, Manufacturer.QISDA),
+    0x0006: (ModelType.RPI_B, "2.0", 256, Manufacturer.EGOMAN),
+    0x0007: (ModelType.RPI_A, "2.0", 256, Manufacturer.EGOMAN),
+    0x0008: (ModelType.RPI_A, "2.0", 256, Manufacturer.SONY_UK),
+    0x0009: (ModelType.RPI_A, "2.0", 256, Manufacturer.QISDA),
+    0x000D: (ModelType.RPI_B, "2.0", 512, Manufacturer.EGOMAN),
+    0x000E: (ModelType.RPI_B, "2.0", 512, Manufacturer.SONY_UK),
+    0x000F: (ModelType.RPI_B, "2.0", 512, Manufacturer.EGOMAN),
+    0x0010: (ModelType.RPI_B_PLUS, "1.2", 512, Manufacturer.SONY_UK),
+    0x0011: (ModelType.RPI_CM1, "1.0", 512, Manufacturer.SONY_UK),
+    0x0012: (ModelType.RPI_A_PLUS, "1.1", 256, Manufacturer.SONY_UK),
+    0x0013: (ModelType.RPI_B_PLUS, "1.2", 512, Manufacturer.EMBEST),
+    0x0014: (ModelType.RPI_CM1, "1.0", 512, Manufacturer.EMBEST),
+    0x0015: (ModelType.RPI_A_PLUS, "1.1", 512, Manufacturer.EMBEST),
+}
+
+
+@dataclass
+class PiHardwareInfo:
+    revision_code: str
+
+    model_type: ModelType = ModelType.UNKNOWN
+    processor: Processor = Processor.UNKNOWN
+    memory: int = 0
+    revision: str = "0.0"
+    serial_number: str = "UNKNOWN"
+    model_name: str = "UNKNOWN"
+
+    overvoltage: bool = False
+    otp_program: bool = False
+    otp_read: bool = False
+
+    manufacturer: Manufacturer = Manufacturer.UNKNOWN
+
+
+def get_info_from_revision_code(revision_code: str) -> PiHardwareInfo:
+    info = PiHardwareInfo(revision_code)
+    code = int(revision_code, 16)
+
+    new_flag = (code & 0x800000) >> 23
+    if new_flag:
+        info.model_type = ModelType((code & 0xFF0) >> 4)
+        info.processor = Processor((code & 0xF000) >> 12)
+        info.memory = _memory[(code & 0x700000) >> 20]
+        info.revision = f"1.{code & 0xF}"
+
+        info.overvoltage = bool((code & 0x80000000) >> 31)
+        info.overvoltage = bool((code & 0x40000000) >> 30)
+        info.overvoltage = bool((code & 0x20000000) >> 29)
+
+        info.manufacturer = Manufacturer((code & 0xF0000) >> 16)
+
+    else:
+        info.model_type = _old_style[code][0]
+        info.revision = _old_style[code][1]
+        info.memory = _old_style[code][2]
+
+        info.manufacturer = _old_style[code][3]
+
+    return info
+
+
+def _get_data_from_line(line: str) -> str:
+    index = line.find(":")
+    if index == -1:
+        return ""
+
+    return line[index + 1 :].lstrip(" ").strip(" \n")
+
+
+def get_info():
+    info = None
+    serial_number = None
+    model_name = None
+
+    try:
+        with open("/proc/cpuinfo") as f:
+            for line in f:
+                if "Revision" in line:
+                    info = get_info_from_revision_code(
+                        re.sub(r"Revision\t: ([a-z0-9]+)\n", r"\1", line)
+                    )
+
+                elif line.startswith("Serial"):
+                    data = _get_data_from_line(line)
+                    if data:
+                        serial_number = data
+
+                elif line.startswith("Model"):
+                    data = _get_data_from_line(line)
+                    if data:
+                        model_name = data
+
+    except FileNotFoundError:
+        logger.warning("Load Raspberry Pi hardware info from /proc/cpuinfo failed!")
+
+    if info is None:
+        return PiHardwareInfo("0000")
+
+    if serial_number:
+        info.serial_number = serial_number
+    if model_name:
+        info.model_name = model_name
+
+    return info
+
+
+if __name__ == "__main__":
+    print(get_info())