qunicorn_core.api.device_api package

Submodules

qunicorn_core.api.device_api.device_view module

Module containing the routes of the devices API.

class qunicorn_core.api.device_api.device_view.DeviceView

Bases: MethodView

Devices Endpoint to get properties of a specific device.

get(device_id)

Get information about a specific device.

methods: t.ClassVar[t.Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class qunicorn_core.api.device_api.device_view.DevicesCalibrationView

Bases: MethodView

Devices Endpoint to get properties of a specific device.

get(device_id)

Get calibration data for a specific device in a uniform way.

methods: t.ClassVar[t.Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class qunicorn_core.api.device_api.device_view.DevicesJobsView

Bases: MethodView

Devices Endpoint to get properties of a specific device/service.

get(device_id)

Get the active jobs of a device.

methods: t.ClassVar[t.Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class qunicorn_core.api.device_api.device_view.DevicesStatusStatus

Bases: MethodView

Devices Endpoint to get properties of a specific device.

get(device_id)

Get the status of a specific device.

methods: t.ClassVar[t.Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

qunicorn_core.api.device_api.root module

Module containing the root endpoint of the DEVICES API.

class qunicorn_core.api.device_api.root.RootData(root: str)

Bases: object

root: str

class qunicorn_core.api.device_api.root.RootView

Bases: MethodView

Root endpoint of the device api, to list all available device_api.

get()

Get the urls of the next endpoints of the device_api api to call.

methods: t.ClassVar[t.Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

Module contents

Module containing the TaskManager API.