jinks_core.device

Module dedicated to discovering and registering devices.

Functions

get_device(name)	Discover devices and return the required device.
register_device(name)	Register a device with the given name.

Classes

DeviceProtocol(*args, **kwargs)

Protocol class for device templates.

Exceptions

JinksDeviceRegisteryError

Device registry error.

exception jinks_core.device.JinksDeviceRegisteryError

Bases: JinksError

Device registry error.

class jinks_core.device.DeviceProtocol(*args, **kwargs)

Bases: Protocol

Protocol class for device templates.

__init__(*args, **kwargs)

jinks_core.device.register_device(name)

Register a device with the given name.

Parameters:

name (str) – Device name

Return type:

Callable

jinks_core.device.get_device(name)

Discover devices and return the required device.

Return type:

type[DeviceProtocol]