device-manager.app.api.devices

Device API Endpoints.

This module defines the API routes and WebSocket endpoints for managing devices. It includes functionalities for: - CRUD operations on devices. - Device registration and status updates via WebSocket.

Copyright (C) 2023, BRAIN-LINK UG (haftungsbeschränkt). All Rights Reserved. SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-ScanHub-Commercial

Attributes

oauth2_scheme
EXAM_MANAGER_URI
LOG_CALL_DELIMITER
router
dict_id_websocket

Functions

get_device_out(→ scanhub_libraries.models.DeviceOut)	Get pydantic device output model helper function.
get_devices(]) → list[scanhub_libraries.models.DeviceOut])	Retrieve the list of registered devices.
get_device(current_user, device_id)	Retrieve a specific device.
create_device(current_user, request)	Create device database entry.
delete_device(device_id)	Delete a device.
start_scan_via_websocket(task, access_token)	Start a scan via a websocket that was already opened by the device.
connection_with_valid_id_and_token(device_id, device_token)	Check if the given device_id and device_token belong to an existing device in the database.
websocket_endpoint(websocket, device_id)	Websocket endpoint for device communication.

Module Contents

device-manager.app.api.devices.oauth2_scheme

device-manager.app.api.devices.EXAM_MANAGER_URI = 'exam-manager:8000'

device-manager.app.api.devices.LOG_CALL_DELIMITER = '-------------------------------------------------------------------------------'

device-manager.app.api.devices.router

device-manager.app.api.devices.dict_id_websocket: Dict[uuid.UUID, fastapi.WebSocket]

async device-manager.app.api.devices.get_device_out(data: api.db.Device) → scanhub_libraries.models.DeviceOut

Get pydantic device output model helper function.

Parameters

data

Database model

Returns

Pydantic output model

async device-manager.app.api.devices.get_devices(current_user: Annotated[scanhub_libraries.models.User, Depends(get_current_user)]) → list[scanhub_libraries.models.DeviceOut]

Retrieve the list of registered devices.

Returns

List[Device]: The list of registered devices.

async device-manager.app.api.devices.get_device(current_user: Annotated[scanhub_libraries.models.User, Depends(get_current_user)], device_id: uuid.UUID)

Retrieve a specific device.

Args

device_id (str): The ID of the device.

Returns

dict: The response containing the information about the device

async device-manager.app.api.devices.create_device(current_user: Annotated[scanhub_libraries.models.User, Depends(get_current_user)], request: scanhub_libraries.models.DeviceCreationRequest)

Create device database entry.

Only devices which are created by a user via this endpoint and have the device_id and device_token that result from this call configured correctly can later connect and register.

Parameters

request:

DeviceCreationRequest to create device in Scanhub. Further details of the device are later provided by the device itself.

Return

device_token:

the token of the device which the user should copy manually to the configuration file of the device.

device_id:

the id of the device, should be copied to the devices config file together with the device_token.

async device-manager.app.api.devices.delete_device(device_id: uuid.UUID)

Delete a device.

Args

device_id (str): The ID of the device.

Returns

dict: The response indicating the success or failure of the deletion.

async device-manager.app.api.devices.start_scan_via_websocket(task: scanhub_libraries.models.AcquisitionTaskOut, access_token: Annotated[str, Depends(oauth2_scheme)])

Start a scan via a websocket that was already opened by the device.

Parameters

device_task

Details of the scan and the device to scan on.

async device-manager.app.api.devices.connection_with_valid_id_and_token(device_id: Annotated[uuid.UUID, Header()], device_token: Annotated[str, Header()])

Check if the given device_id and device_token belong to an existing device in the database.

Args

device_id (UUID): The device_id to check against the database. device_token (str): The device_token to check against the database.

async device-manager.app.api.devices.websocket_endpoint(websocket: fastapi.WebSocket, device_id: Annotated[uuid.UUID, Depends(connection_with_valid_id_and_token)])

Websocket endpoint for device communication.

Args

websocket (WebSocket): The WebSocket connection object. device_id (UUID): The device_id.