advantech-edge

Python hardware-abstraction library for Advantech edge devices (industrial IoT boards). Exposes board features through a stable public API while dispatching underneath to whichever vendor hardware library is installed on the host: SUSI, SUSI IoT, or EAPI. Mirrors the API shape of the sibling C# library Advantech.Edge.

Requirements

• Linux (x86-64 or ARM64)
• Python ≥ 3.8
• Root / Administrator privileges at runtime
• One of the Advantech vendor libraries installed on the host: SUSI, SUSI IoT, or EAPI

Installation

# From public PyPI
pip install advantech-edge

# From the internal Azure Artifacts feed (pre-release / QA-validated builds)
pip install --index-url <FEED_URL> advantech-edge

# From a local wheel
pip install dist/advantech_edge-<version>-py3-none-any.whl

Quick Start

from advantech.edge.platform import MainBoard

with MainBoard() as board:
    # Board identification
    print(board.board_info.name)          # e.g. "MIC-770"
    print(board.board_info.manufacturer)  # e.g. "Advantech"
    print(board.board_info.bios_version)  # e.g. "5.27"

    # Onboard sensors (None if unsupported by the active backend)
    if board.onboard_sensors:
        for src in board.onboard_sensors.temperature_sources:
            sample = board.onboard_sensors.get_temperature(src)
            print(sample.source, sample.value)  # degrees Celsius
        for src in board.onboard_sensors.voltage_sources:
            sample = board.onboard_sensors.get_voltage(src)
            print(sample.source, sample.value)  # volts
        for src in board.onboard_sensors.fan_sources:
            sample = board.onboard_sensors.get_fan_speed(src)
            print(sample.source, sample.value)  # RPM

    # GPIO (None if unsupported)
    if board.gpio:
        from advantech.edge.platform import GpioDirection, GpioLevel
        board.gpio.set_direction(0, GpioDirection.OUTPUT)
        board.gpio.set_level(0, GpioLevel.HIGH)
        print(board.gpio.get_level(0))

    # Watchdog (None if unsupported)
    if board.watchdog:
        for timer in board.watchdog.timer_ids:
            print(board.watchdog.try_get_cap(timer))
            print(board.watchdog.try_get_config(timer))

    # Thermal protection (None if unsupported)
    if board.thermal_protection:
        for zone in board.thermal_protection.zone_ids:
            print(board.thermal_protection.try_get_zone_cap(zone))

API Overview

Features not supported by the active backend are exposed as None on the MainBoard instance.

Supported Backends

The library auto-detects which vendor library is installed and selects the appropriate backend.