devices_api module

DevicesApi

class edgeimpulse_api.api.devices_api.DevicesApi(
		api_client=None
)

Parameters

  • api_client=None

Methods

create_device

edgeimpulse_api.api.devices_api.create_device(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		create_device_request: edgeimpulse_api.models.create_device_request.CreateDeviceRequest,
		**kwargs
)> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Create device

Create a new device. If you set ifNotExists to false and the device already exists, the deviceType will be overwritten.

Parameters

  • self

  • project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

  • create_device_request: edgeimpulse_api.models.create_device_request.CreateDeviceRequest

  • **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

delete_device

edgeimpulse_api.api.devices_api.delete_device(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		device_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Device ID', extra={})],
		**kwargs
)> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Delete device

Delete a device. When this device sends a new message to ingestion or connects to remote management the device will be recreated.

Parameters

  • self

  • project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

  • device_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Device ID', extra={})]

  • **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

get_device

edgeimpulse_api.api.devices_api.get_device(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		device_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Device ID', extra={})],
		**kwargs
)> edgeimpulse_api.models.get_device_response.GetDeviceResponse

Get device

Retrieves a single device

Parameters

  • self

  • project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

  • device_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Device ID', extra={})]

  • **kwargs

Return

edgeimpulse_api.models.get_device_response.GetDeviceResponse

get_impulse_records

edgeimpulse_api.api.devices_api.get_impulse_records(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],