client_pigpio module

Declares constants and interfaces for compatibility with pigpio.

Note that the supported serial interface (UART) is taken from picod. See client_picod.

Interfaces

class gpiosvr.client_pigpio.PigpioMinimalApi

Contains the minimal interface from pigpio’s pi class, in an async version.

abstract async set_mode(gpio: int, mode: int)

See pigpio

abstract async get_mode(gpio: int) int

See pigpio

Return type:

int

abstract async set_pull_up_down(gpio: int, pud: int)

See pigpio

abstract async read(gpio: int) int

See pigpio

abstract async write(gpio: int, level: int)

See pigpio

abstract async get_current_tick() int

See pigpio

abstract stop()

See pigpio

class gpiosvr.client_pigpio.PigpioCallbackApi

Contains methods related to edge callbacks from pigpio’s pi class, in an async version.

abstract async set_watchdog(user_gpio: int, wdog_timeout_ms: int)

See pigpio

abstract async set_glitch_filter(user_gpio: int, steady_μs: int)

See pigpio

abstract async callback(user_gpio: int, edge: int = 0, func: callable | None = None)

See pigpio

class gpiosvr.client_pigpio.PigpioPwmApi

Contains PWM-related methods from pigpio’s pi class, in an async version.

abstract async set_PWM_dutycycle(user_gpio: int, dutycycle: int)

See pigpio

abstract async get_PWM_dutycycle(user_gpio: int) int

See pigpio

abstract async set_PWM_range(user_gpio: int, range_: int)

See pigpio

abstract async get_PWM_range(user_gpio: int) int

See pigpio

abstract async get_PWM_real_range(user_gpio: int) int

See pigpio

abstract async set_PWM_frequency(user_gpio: int, frequency: int)

See pigpio

abstract async get_PWM_frequency(user_gpio: int) int

See pigpio

abstract async hardware_PWM(gpio: int, PWMfreq_hz: int, PWMduty: int)

See pigpio

class gpiosvr.client_pigpio.PigpioScriptApi

Contains script-related methods from pigpio’s pi class, in an async version.

abstract async store_script(script: str)

See pigpio

abstract async run_script(script_id: int, params: list | None = None)

See pigpio

abstract async script_status(script_id: int) int

See pigpio

abstract async delete_script(script_id: int)

See pigpio

Constants and defaults

class gpiosvr.client_pigpio.pigpio

Constants and methods for compatibility with pigpio.

INPUT = 0
OUTPUT = 1
PUD_OFF = 0
PUD_DOWN = 1
PUD_UP = 2
RISING_EDGE = 0
FALLING_EDGE = 1
EITHER_EDGE = 2
TIMEOUT = 2
PI_SCRIPT_INITING = 0
PI_SCRIPT_HALTED = 1
PI_SCRIPT_RUNNING = 2
PI_SCRIPT_WAITING = 3
PI_SCRIPT_FAILED = 4
static tickDiff(t1, t2)