qmi.instruments.raspberry.gpio
Instrument driver for the Raspberry Pi peripheral I/O.
Classes
|
Instrument driver for the Raspberry Pi I/O, based on the 'RPi' module. |
- class qmi.instruments.raspberry.gpio.RaspberryPiGPIO(context: QMI_Context, name: str)
Instrument driver for the Raspberry Pi I/O, based on the ‘RPi’ module.
NOTE: It is only sensible to instantiate this driver on a Raspberry Pi. Of course, from then on, it can be accessed via RPC.
This is based on the package RPi.GPIO. We expose a subset of its functionality.
- class gpio_mode(value)
- open() None
Connect to the instrument hardware.
When this method returns, the instrument must be ready for interaction via calls to instrument-specific methods.
Subclasses can extend this method to implement instrument-specific initialization. If they do, they should call
super().open()as a last statement.
- close() None
Close the connection to the instrument hardware and release associated resources.
When this method returns, the instrument must not be used again unless it is first re-opened by calling the open() method.
Subclasses can extend this method if they have specific resources to close. If they do, they should call
super().close()as a last statement.
- gpio_setup(pin_nr: int, mode: gpio_mode) None
Setup a GPIO pin in given mode.
- Parameters:
pin_nr – The pin number to setup.
mode – The mode the pin should be setup. Options: gpio_mode.INPUT, gpio_mode.OUTPUT.
- gpio_input(pin_nr: int) bool
Check if given pin is in high lor low state.
- Parameters:
pin_nr – The pin number to check.
- Returns:
True if the pin state is GPIO.HIGH, False otherwise.
- Return type:
- force_unlock() None
Forcefully unlock the remote object.
This unlocks the object, regardless of who owns the lock. This allows you to unlock an object if the locking proxy has been destroyed without unlocking.
Use this with care.
Do not override this stub method in subclasses. It has already been implemented in QMI_RpcProxy.
- classmethod get_category() str | None
Return the optional name of the category this object belongs to.
A category name is a free-form string that has no special significance. Its purpose is to distinguish between groups of RPC objects that fulfill similar roles.
- get_name() str
Return the name of this object.
- Returns:
name attribute.
- get_signals() list[SignalDescription]
Return a list of signals that can be published by this object.
- Returns:
List consisting of qmi_signals attributes.
- gpio_output(pin_nr: int, value: bool) None
Set given pin output to high or low.
- Parameters:
pin_nr – The pin number to be set.
value – True to set pin to GPIO.HIGH or False to set pin to GPIO.LOW.
- is_locked() bool
Query if the remote object is locked.
Do not override this stub method in subclasses. It has already been implemented in QMI_RpcProxy.
- is_open() bool
Return True if the instrument is open (ready for interaction).
- lock(timeout: float = 0.0, lock_token: str | None = None) bool
Lock the remote object. If timeout is given, try every 0.1s within the given timeout value. The remote object can be locked with an optional custom lock token by giving a string into lock_token keyword argument.
If successful, this proxy is the only proxy that can invoke RPC methods on the remote object; other proxies will receive an “object is locked” response. The return value indicates if the lock was granted; a denied lock means the object was already locked by another proxy.
Do not override this stub method in subclasses. It has already been implemented in QMI_RpcProxy.
- release_rpc_object() None
Give a warning if the instrument is removed while still open.
- unlock(lock_token: str | None = None) bool
Unlock the remote object.
Without optional parameters, this is only allowed by the proxy that initially locked the object. By giving the lock token as an input parameter, the specific object locked by this token can be unlocked. The return value indicates if the unlocking was successful.
Do not override this stub method in subclasses. It has already been implemented in QMI_RpcProxy.