asmb6-api 1.0.0__tar.gz

asmb6_api-1.0.0/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: asmb6-api
+Version: 1.0.0
+Summary: Python API for ASMB6-iKVM remote management.
+Home-page: https://github.com/grifonice99/asmb6-api
+Author: Grifonice99
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7,<4
+Description-Content-Type: text/markdown
+Requires-Dist: requests<3,>=2.28
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# ASMB6 API
+
+A Python interface for interacting with the ASMB6-iKVM remote management module.
+
+This library provides programmatic access to authentication, session handling, hardware monitoring, and basic power management functions through the module’s HTTP management interface.
+
+---
+
+## Overview
+
+The ASMB6 API is designed as a lightweight Python wrapper around the module’s web-based management interface. It enables automation and integration into scripts or monitoring systems without relying on the WebUI.
+
+The library provides:
+
+* Session-based authentication
+* Structured sensor objects
+* Power and host state queries
+* Programmatic power control operations
+
+The goal is to expose a clean and predictable Python interface suitable for automation and monitoring tasks.
+
+---
+
+## Features
+
+### Authentication & Session Management
+
+* Login and logout support
+* Session validation
+* Explicit return codes for API calls
+
+### Hardware Monitoring
+
+* Temperature sensors
+* Voltage sensors
+* Fan speed monitoring
+* Power supply status
+* Structured `Sensors` container with parsed values
+* Access to raw sensor payload for debugging
+
+### Host Control & Status
+
+* Retrieve host power state
+* Query power button status
+* Power control operations (shutdown, power on, reset, cycle)
+
+---
+
+## Installation
+
+Clone the repository:
+
+```bash
+git clone https://github.com/Grifonice99/asmb6-api
+cd asmb6-api
+```
+
+Install required dependency:
+
+```bash
+pip install requests
+```
+
+---
+
+## Basic Usage
+
+```python
+from apmi import APMI
+
+apmi = APMI("192.168.1.100")
+
+# Authenticate
+status = apmi.login("admin", "password")
+if status != 0:
+    raise RuntimeError(f"Login failed with code {status}")
+
+# Query host power state
+powered_on = apmi.status()
+print("Host is on" if powered_on else "Host is off")
+
+# Retrieve sensors
+sensors = apmi.sensors()
+print(sensors.cpu1.reading)
+
+# Logout
+apmi.logout()
+```
+
+---
+
+## Design Notes
+
+* Command execution methods return explicit status codes.
+* Device state queries return domain-level values (e.g., `bool`).
+* Sensor data is exposed through structured objects rather than raw dictionaries.
+* Raw sensor payload data remains accessible for debugging or inspection purposes.
+
+---
+
+## Disclaimer
+
+This project was developed and tested on an ASUS Z9PE-D16 motherboard equipped with an ASMB6-iKVM module.
+
+Compatibility with other motherboards, firmware versions, or ASMB6 variants is not guaranteed. Behavior may differ depending on firmware revisions or platform-specific implementations.
+
+Users are encouraged to test carefully in their own environment before relying on this library in production systems.
+
+---
+
+## License
+
+This project is licensed under the terms defined in the `LICENSE` file.

asmb6_api-1.0.0/asmb6/__init__.py

@@ -0,0 +1,3 @@
+from .apmi_interface import APMI
+from .parser import Sensors
+__version__ = "1.0.0"

asmb6_api-1.0.0/asmb6/apmi_interface.py

@@ -0,0 +1,161 @@
+import requests
+import re
+import json
+from .parser import sanitize, serialize, parse_sensors, Sensors
+
+start_ref = """<?xml version="1.0" encoding="UTF-8"?>
+
+<jnlp spec="1.0+" codebase="""
+end_ref = """    </application-desc>
+</jnlp>
+"""
+
+
+class APMI:
+    def __init__(self, ip, http_port=80):
+        self.http_port = http_port
+        self.username = None
+        self.ip = ip
+        self.session = requests.Session()
+        self.base = f"http://{self.ip}:{self.http_port}"
+
+    def login(self, username, password) -> int:
+        """
+        Important:
+            Always call logout() before terminating the program.
+
+            Failing to do so may leave an active session on the
+            ASMB6-iKVM, which can cause login issues during
+            development or repeated test runs.
+        """
+        data = {
+            "WEBVAR_USERNAME": username,
+            "WEBVAR_PASSWORD": password,
+        }
+
+        res = self.session.post(self.base + "/rpc/WEBSES/create.asp", data=data)
+    
+        json_res = json.loads(serialize(sanitize(res.text)))["WEBVAR_JSONVAR_WEB_SESSION"]
+        status = json_res["HAPI_STATUS"]
+        if status != 0:
+            print(f"Invalid credential")
+        else:
+            session_cookie = json_res["WEBVAR_STRUCTNAME_WEB_SESSION"][0]["SESSION_COOKIE"]
+            
+            self.session.cookies.set("Username", username, domain=self.ip, path="/")
+            self.session.cookies.set("Language", "EN", domain=self.ip, path="/")
+            self.session.cookies.set("SessionCookie", session_cookie, domain=self.ip, path="/")
+            self.username = username
+        
+        return status
+
+    def logout(self)->int:
+        res = self.session.get(self.base + "/rpc/WEBSES/logout.asp")
+        self.session = requests.Session()
+        self.username = None
+        return json.loads(serialize(sanitize(res.text)))["WEBVAR_JSONVAR_WEB_SESSION_LOGOUT"]["HAPI_STATUS"]
+
+    def validate_session(self)->int:
+        if not self.username:
+            raise Exception("You need to be authenticated")
+        res = self.session.get(self.base + "/rpc/WEBSES/validate.asp").text
+        return json.loads(serialize(sanitize(res.text)))["WEBVAR_JSONVAR_WEB_SESSION_VALIDATE"]["HAPI_STATUS"]
+    
+    def sensors(self) -> Sensors:
+        if not self.username:
+            raise Exception("You need to be authenticated")
+        res = self.session.get(self.base + "/rpc/getallsensors.asp")
+        raw = json.loads(serialize(sanitize(res.text)))
+        sensors_data = raw["WEBVAR_JSONVAR_HL_GETALLSENSORS"][
+            "WEBVAR_STRUCTNAME_HL_GETALLSENSORS"
+        ]
+        sensors = parse_sensors(sensors_data)
+        return sensors
+
+    def status(self) -> int:
+        if not self.username:
+            raise Exception("You need to be authenticated")
+        res = self.session.get(self.base + "/rpc/hoststatus.asp")
+        raw = json.loads(serialize(sanitize(res.text)))
+        return raw["WEBVAR_JSONVAR_HL_SYSTEM_STATE"][
+            "WEBVAR_STRUCTNAME_HL_SYSTEM_STATE"
+        ][0]["JF_STATE"]
+
+    def pwr_btn_status(self) -> int:
+        if not self.username:
+            raise Exception("You need to be authenticated")
+        res = self.session.get(self.base + "/rpc/PWRbutton.asp")
+        raw = json.loads(serialize(sanitize(res.text)))
+        return raw["WEBVAR_JSONVAR_HL_BUTTON_STATE"][
+            "WEBVAR_STRUCTNAME_HL_BUTTON_STATE"
+        ][0]["PB_STATE"]
+
+    def turn_off_board(self, immediate=False) -> None:
+        """
+        Note:
+            immediate=True may not turn the board off if it was powered on
+            less than 15 seconds before this call.
+        """
+        if not self.username:
+            raise Exception("You need to be authenticated")
+        if immediate:
+            res = self.session.post(
+                self.base + "/rpc/hostctl.asp", data={"WEBVAR_POWER_CMD": 0}
+            )
+        else:
+            res = self.session.post(
+                self.base + "/rpc/hostctl.asp", data={"WEBVAR_POWER_CMD": 5}
+            )
+
+    def turn_on_board(self) -> None:
+        if not self.username:
+            raise Exception("You need to be authenticated")
+        res = self.session.post(
+            self.base + "/rpc/hostctl.asp", data={"WEBVAR_POWER_CMD": 1}
+        )
+
+    def power_cycle_board(self) -> None:
+        if not self.username:
+            raise Exception("You need to be authenticated")
+        res = self.session.post(
+            self.base + "/rpc/hostctl.asp", data={"WEBVAR_POWER_CMD": 2}
+        )
+
+    def reset_board(self) -> None:
+        if not self.username:
+            raise Exception("You need to be authenticated")
+        res = self.session.post(
+            self.base + "/rpc/hostctl.asp", data={"WEBVAR_POWER_CMD": 3}
+        )
+
+    def get_events(self) -> dict:
+        if not self.username:
+            raise Exception("You need to be authenticated")
+        res = self.session.get(self.base + "/rpc/getallselentries.asp")
+        result = json.loads(serialize(sanitize(res.text)))[
+            "WEBVAR_JSONVAR_HL_GETALLSELENTRIES"
+        ]["WEBVAR_STRUCTNAME_HL_GETALLSELENTRIES"][:-1]
+        return result
+
+    def get_jnlp(self) -> str:
+        if not self.username:
+            raise Exception("You need to be authenticated")
+        
+        res = self.session.get(
+            self.base + f"/Java/jviewer.jnlp?EXTRNIP={self.base}&JNLPSTR=JViewer",
+            stream=True,
+        )
+
+        data = b""
+        try:
+            for chunk in res.iter_content(1):
+                if chunk:
+                    data += chunk
+        except requests.exceptions.RequestException as e:
+            # Strings parsed from the firmware's jviewer.jnlp template.
+            if data.startswith(start_ref.encode()) and data.endswith(end_ref.encode()):
+                print("Notice: The data appears to have downloaded correctly, but the firmware closed the connection before all content-length data was received.")
+            else:
+                raise e
+
+        return data.decode()

asmb6_api-1.0.0/asmb6/parser.py

@@ -0,0 +1,167 @@
+import re
+
+# IPMI sensor type codes:
+# 1   : Temperature
+# 2   : Voltage
+# 4   : Fan
+# 5   : Physical Security
+# 8   : PMB Power
+# 12  : Memory ECC Sensor
+# 13  : Drive Slot
+# 35  : Watchdog
+# 193 : OEM Memory ECC Sensor
+# 220 : Node Manager capabilities
+
+
+class base:
+    def __init__(self):
+        super().__init__()
+        self.reading = None
+        self.unr = None
+        self.uc = None
+        self.unc = None
+        self.lnr = None
+        self.lc = None
+        self.lnc = None
+        self.state = None
+
+
+class Temperature(base):
+    def __init__(self):
+        super().__init__()
+
+
+class Voltage(base):
+
+    def __init__(self):
+        super().__init__()
+
+
+class Fan(base):
+    def __init__(self):
+        super().__init__()
+
+
+class StateOnly:
+    def __init__(self):
+        self.state = None
+
+
+class PowerSupply(base):
+    def __init__(self):
+        super().__init__()
+
+
+class Fan(base):
+    def __init__(self):
+        super().__init__()
+
+
+class Sensors:
+    def __init__(self):
+        self.cpu1: Temperature = Temperature()
+        self.cpu2: Temperature = Temperature()
+        self.tr1: Temperature = Temperature()
+        self.tr2: Temperature = Temperature()
+        self.vcore1: Voltage = Voltage()
+        self.vcore2: Voltage = Voltage()
+        self.vtt_cpu: Voltage = Voltage()
+        self.vddq_ab_cpu1: Voltage = Voltage()
+        self.vddq_cd_cpu1: Voltage = Voltage()
+        self.vddq_ef_cpu2: Voltage = Voltage()
+        self.vddq_gh_cpu2: Voltage = Voltage()
+        self.v12: Voltage = Voltage()
+        self.v5: Voltage = Voltage()
+        self.vsb5: Voltage = Voltage()
+        self.v3_3: Voltage = Voltage()
+        self.vsb3_3: Voltage = Voltage()
+        self.vbat: Voltage = Voltage()
+        self.cpu_fan1: Fan = Fan()
+        self.cpu_fan2: Fan = Fan()
+        self.frnt_fan1: Fan = Fan()
+        self.frnt_fan2: Fan = Fan()
+        self.frnt_fan3: Fan = Fan()
+        self.frnt_fan4: Fan = Fan()
+        self.rear_fan1: Fan = Fan()
+        self.rear_fan2: Fan = Fan()
+        self.cpu1_ecc1: StateOnly = StateOnly()
+        self.cpu1_ecc2: StateOnly = StateOnly()
+        self.cpu2_ecc1: StateOnly = StateOnly()
+        self.cpu2_ecc2: StateOnly = StateOnly()
+        self.pmbpower: PowerSupply = PowerSupply()
+        self.chassisintrusion: StateOnly = StateOnly()
+        self.watchdog2: StateOnly = StateOnly()
+        self.nm_capabilities: StateOnly = StateOnly()
+        self.raw = {}
+
+
+def serialize(raw):
+    raw = raw.replace("=", ":")
+    raw = raw.replace(";", "")
+    raw = re.sub(r"(\b[A-Za-z_][A-Za-z0-9_]*\b)\s*:", r'"\1":', raw)
+    raw = raw.replace("'", '"')
+    return raw
+
+
+def sanitize(text: str):
+    return (
+        "{"
+        + "\n".join(filter(lambda x: not x.startswith("//"), text.split("\n")))
+        + "}"
+    )
+
+
+def Parse_data(raw) -> base:
+    sensor: base = base()
+    sensor.lnc = raw["LowNCThresh"]
+    sensor.lc = raw["LowCTThresh"]
+    sensor.lnr = raw["LowNRThresh"]
+    sensor.unc = raw["HighNCThresh"]
+    sensor.uc = raw["HighCTThresh"]
+    sensor.unr = raw["HighNRThresh"]
+    sensor.reading = raw["SensorReading"]/1000
+    sensor.state = raw["SensorState"]
+    return sensor
+
+
+def parse_sensors(raw) -> Sensors:
+    SensorsDict = {}
+    for x in raw:
+        if "SensorNumber" in x:
+            SensorsDict[x["SensorNumber"]] = x
+
+    sensors = Sensors()
+    sensors.cpu1 = Parse_data(SensorsDict[49])
+    sensors.cpu2 = Parse_data(SensorsDict[50])
+    sensors.vcore1 = Parse_data(SensorsDict[52])
+    sensors.vcore2 = Parse_data(SensorsDict[53])
+    sensors.v3_3 = Parse_data(SensorsDict[54])
+    sensors.v5 = Parse_data(SensorsDict[55])
+    sensors.v12 = Parse_data(SensorsDict[56])
+    sensors.vsb5 = Parse_data(SensorsDict[59])
+    sensors.vbat = Parse_data(SensorsDict[60])
+    sensors.vtt_cpu = Parse_data(SensorsDict[61])
+    sensors.vsb3_3 = Parse_data(SensorsDict[64])
+    sensors.vddq_ab_cpu1 = Parse_data(SensorsDict[77])
+    sensors.vddq_cd_cpu1 = Parse_data(SensorsDict[78])
+    sensors.vddq_ef_cpu2 = Parse_data(SensorsDict[80])
+    sensors.vddq_gh_cpu2 = Parse_data(SensorsDict[81])
+    sensors.cpu_fan1 = Parse_data(SensorsDict[160])
+    sensors.cpu_fan2 = Parse_data(SensorsDict[161])
+    sensors.frnt_fan1 = Parse_data(SensorsDict[162])
+    sensors.frnt_fan2 = Parse_data(SensorsDict[163])
+    sensors.frnt_fan3 = Parse_data(SensorsDict[164])
+    sensors.frnt_fan4 = Parse_data(SensorsDict[165])
+    sensors.rear_fan1 = Parse_data(SensorsDict[166])
+    sensors.rear_fan2 = Parse_data(SensorsDict[167])
+    sensors.tr1 = Parse_data(SensorsDict[204])
+    sensors.tr2 = Parse_data(SensorsDict[205])
+    sensors.nm_capabilities.state = SensorsDict[26]["SensorState"]
+    sensors.chassisintrusion.state = SensorsDict[79]["SensorState"]
+    sensors.cpu1_ecc1.state = SensorsDict[209]["SensorState"]
+    sensors.cpu1_ecc2.state = SensorsDict[210]["SensorState"]
+    sensors.cpu2_ecc1.state = SensorsDict[211]["SensorState"]
+    sensors.cpu2_ecc2.state = SensorsDict[212]["SensorState"]
+    sensors.watchdog2.state = SensorsDict[255]["SensorState"]
+    sensors.raw=SensorsDict
+    return sensors

asmb6_api-1.0.0/asmb6_api.egg-info/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: asmb6-api
+Version: 1.0.0
+Summary: Python API for ASMB6-iKVM remote management.
+Home-page: https://github.com/grifonice99/asmb6-api
+Author: Grifonice99
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7,<4
+Description-Content-Type: text/markdown
+Requires-Dist: requests<3,>=2.28
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# ASMB6 API
+
+A Python interface for interacting with the ASMB6-iKVM remote management module.
+
+This library provides programmatic access to authentication, session handling, hardware monitoring, and basic power management functions through the module’s HTTP management interface.
+
+---
+
+## Overview
+
+The ASMB6 API is designed as a lightweight Python wrapper around the module’s web-based management interface. It enables automation and integration into scripts or monitoring systems without relying on the WebUI.
+
+The library provides:
+
+* Session-based authentication
+* Structured sensor objects
+* Power and host state queries
+* Programmatic power control operations
+
+The goal is to expose a clean and predictable Python interface suitable for automation and monitoring tasks.
+
+---
+
+## Features
+
+### Authentication & Session Management
+
+* Login and logout support
+* Session validation
+* Explicit return codes for API calls
+
+### Hardware Monitoring
+
+* Temperature sensors
+* Voltage sensors
+* Fan speed monitoring
+* Power supply status
+* Structured `Sensors` container with parsed values
+* Access to raw sensor payload for debugging
+
+### Host Control & Status
+
+* Retrieve host power state
+* Query power button status
+* Power control operations (shutdown, power on, reset, cycle)
+
+---
+
+## Installation
+
+Clone the repository:
+
+```bash
+git clone https://github.com/Grifonice99/asmb6-api
+cd asmb6-api
+```
+
+Install required dependency:
+
+```bash
+pip install requests
+```
+
+---
+
+## Basic Usage
+
+```python
+from apmi import APMI
+
+apmi = APMI("192.168.1.100")
+
+# Authenticate
+status = apmi.login("admin", "password")
+if status != 0:
+    raise RuntimeError(f"Login failed with code {status}")
+
+# Query host power state
+powered_on = apmi.status()
+print("Host is on" if powered_on else "Host is off")
+
+# Retrieve sensors
+sensors = apmi.sensors()
+print(sensors.cpu1.reading)
+
+# Logout
+apmi.logout()
+```
+
+---
+
+## Design Notes
+
+* Command execution methods return explicit status codes.
+* Device state queries return domain-level values (e.g., `bool`).
+* Sensor data is exposed through structured objects rather than raw dictionaries.
+* Raw sensor payload data remains accessible for debugging or inspection purposes.
+
+---
+
+## Disclaimer
+
+This project was developed and tested on an ASUS Z9PE-D16 motherboard equipped with an ASMB6-iKVM module.
+
+Compatibility with other motherboards, firmware versions, or ASMB6 variants is not guaranteed. Behavior may differ depending on firmware revisions or platform-specific implementations.
+
+Users are encouraged to test carefully in their own environment before relying on this library in production systems.
+
+---
+
+## License
+
+This project is licensed under the terms defined in the `LICENSE` file.

asmb6_api-1.0.0/asmb6_api.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+setup.py
+asmb6/__init__.py
+asmb6/apmi_interface.py
+asmb6/parser.py
+asmb6_api.egg-info/PKG-INFO
+asmb6_api.egg-info/SOURCES.txt
+asmb6_api.egg-info/dependency_links.txt
+asmb6_api.egg-info/requires.txt
+asmb6_api.egg-info/top_level.txt

asmb6_api-1.0.0/asmb6_api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

asmb6_api-1.0.0/asmb6_api.egg-info/requires.txt

@@ -0,0 +1 @@
+requests<3,>=2.28

asmb6_api-1.0.0/asmb6_api.egg-info/top_level.txt

@@ -0,0 +1 @@
+asmb6

asmb6_api-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

asmb6_api-1.0.0/setup.py

@@ -0,0 +1,33 @@
+from setuptools import setup, find_packages
+from pathlib import Path
+import re
+
+here = Path(__file__).parent.resolve()
+
+init_text = (here / "asmb6" / "__init__.py").read_text(encoding="utf-8")
+match = re.search(r'^__version__\s*=\s*["\']([^"\']+)["\']',
+                  init_text, re.M)
+
+if not match:
+    raise RuntimeError("Version not found")
+
+version = match.group(1)
+
+long_description = (here / "readme.md").read_text(encoding="utf-8")
+
+setup(
+    name="asmb6-api",
+    version=version,
+    description="Python API for ASMB6-iKVM remote management.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/grifonice99/asmb6-api",
+    author="Grifonice99",
+    python_requires=">=3.7,<4",
+    packages=find_packages(exclude=("tests", "docs")),
+    install_requires=["requests>=2.28,<3"],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "Operating System :: OS Independent",
+    ],
+)