api library

Classes

AccessLevel
AccessLevelTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AccessLevel to int, and decode dynamic data back to AccessLevel.
ApiClient
AssetsConnection
AssetsConnectionModbusRTU
AssetsConnectionModbusTCP
AssetsConnectionOPCUA
AssetsConnectionS7
AssetsGroup
AssetsMetric
AssetsMetricModbusRTU
AssetsMetricModbusRTUActivationEdgeEnum
active edge for alarm, if category is alarm
AssetsMetricModbusRTUActivationEdgeEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricModbusRTUActivationEdgeEnum to String, and decode dynamic data back to AssetsMetricModbusRTUActivationEdgeEnum.
AssetsMetricModbusRTUByteOrderEnum
AssetsMetricModbusRTUByteOrderEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricModbusRTUByteOrderEnum to String, and decode dynamic data back to AssetsMetricModbusRTUByteOrderEnum.
AssetsMetricModbusRTUDataTypeEnum
AssetsMetricModbusRTUDataTypeEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricModbusRTUDataTypeEnum to String, and decode dynamic data back to AssetsMetricModbusRTUDataTypeEnum.
AssetsMetricModbusRTUMemoryAreaEnum
AssetsMetricModbusRTUMemoryAreaEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricModbusRTUMemoryAreaEnum to String, and decode dynamic data back to AssetsMetricModbusRTUMemoryAreaEnum.
AssetsMetricModbusRTUResponse
AssetsMetricModbusTCP
AssetsMetricModbusTCPActivationEdgeEnum
active edge for alarm, if category is alarm
AssetsMetricModbusTCPActivationEdgeEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricModbusTCPActivationEdgeEnum to String, and decode dynamic data back to AssetsMetricModbusTCPActivationEdgeEnum.
AssetsMetricModbusTCPByteOrderEnum
AssetsMetricModbusTCPByteOrderEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricModbusTCPByteOrderEnum to String, and decode dynamic data back to AssetsMetricModbusTCPByteOrderEnum.
AssetsMetricModbusTCPDataTypeEnum
AssetsMetricModbusTCPDataTypeEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricModbusTCPDataTypeEnum to String, and decode dynamic data back to AssetsMetricModbusTCPDataTypeEnum.
AssetsMetricModbusTCPMemoryAreaEnum
AssetsMetricModbusTCPMemoryAreaEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricModbusTCPMemoryAreaEnum to String, and decode dynamic data back to AssetsMetricModbusTCPMemoryAreaEnum.
AssetsMetricModbusTCPRequestBody
AssetsMetricModbusTCPRequestBodyTypeEnum
AssetsMetricModbusTCPRequestBodyTypeEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricModbusTCPRequestBodyTypeEnum to String, and decode dynamic data back to AssetsMetricModbusTCPRequestBodyTypeEnum.
AssetsMetricModbusTCPResponse
AssetsMetricOPCUA
AssetsMetricOPCUAActivationEdgeEnum
active edge for alarm, if category is alarm
AssetsMetricOPCUAActivationEdgeEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricOPCUAActivationEdgeEnum to String, and decode dynamic data back to AssetsMetricOPCUAActivationEdgeEnum.
AssetsMetricOPCUADataTypeEnum
AssetsMetricOPCUADataTypeEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricOPCUADataTypeEnum to String, and decode dynamic data back to AssetsMetricOPCUADataTypeEnum.
AssetsMetricOPCUAIdentifierTypeEnum
AssetsMetricOPCUAIdentifierTypeEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricOPCUAIdentifierTypeEnum to String, and decode dynamic data back to AssetsMetricOPCUAIdentifierTypeEnum.
AssetsMetricOPCUARequestBody
AssetsMetricOPCUARequestBodyTypeEnum
AssetsMetricOPCUARequestBodyTypeEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricOPCUARequestBodyTypeEnum to String, and decode dynamic data back to AssetsMetricOPCUARequestBodyTypeEnum.
AssetsMetricOPCUAResponse
AssetsMetricS7
AssetsMetricS7ActivationEdgeEnum
active edge for alarm, if category is alarm
AssetsMetricS7ActivationEdgeEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricS7ActivationEdgeEnum to String, and decode dynamic data back to AssetsMetricS7ActivationEdgeEnum.
AssetsMetricS7DataTypeEnum
AssetsMetricS7DataTypeEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricS7DataTypeEnum to String, and decode dynamic data back to AssetsMetricS7DataTypeEnum.
AssetsMetricS7MemoryAreaEnum
AssetsMetricS7MemoryAreaEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricS7MemoryAreaEnum to String, and decode dynamic data back to AssetsMetricS7MemoryAreaEnum.
AssetsMetricS7RequestBody
AssetsMetricS7RequestBodyTypeEnum
AssetsMetricS7RequestBodyTypeEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricS7RequestBodyTypeEnum to String, and decode dynamic data back to AssetsMetricS7RequestBodyTypeEnum.
AssetsMetricS7Response
AssetsMetricS7TopicEnum
topic to publish to
AssetsMetricS7TopicEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsMetricS7TopicEnum to String, and decode dynamic data back to AssetsMetricS7TopicEnum.
AssetsMetricsDataTypeEnum
AssetsMetricsDataTypeEnumTypeAssetsTransformer
AssetsParametersModbusRTU
AssetsParametersModbusRTUDataBitsEnum
AssetsParametersModbusRTUParityEnum
AssetsParametersModbusRTUStopBitsEnum
AssetsParametersModbusTCP
AssetsParametersOPCUA
AssetsParametersS7
AssetsProtocolEnum
AssetsProtocolEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsProtocolEnum to String, and decode dynamic data back to AssetsProtocolEnum.
AssetsTransform
AssetsTransformKindEnum
AssetsTransformKindEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsTransformKindEnum to String, and decode dynamic data back to AssetsTransformKindEnum.
AssetsTransformsApi
AssetsTransformsRequestBody
AssetsTransformsRequestBodyData
AssetsTransformsRequestBodyDataKindEnum
AssetsTransformsRequestBodyDataKindEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of AssetsTransformsRequestBodyDataKindEnum to String, and decode dynamic data back to AssetsTransformsRequestBodyDataKindEnum.
ChannelType
ChannelTypeTypeAssetsTransformer
AssetsTransformation class that can encode an instance of ChannelType to String, and decode dynamic data back to ChannelType.
ConnectionParameters
DeserializationMessage
Primarily intended for use in an isolate.
Device
DeviceIngestionConfig
DeviceModel
DeviceModelIngestionConfig
DeviceModelMetricItemRequest
DeviceModelMetricItemRequestTypeEnum
DeviceModelMetricItemRequestTypeEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of DeviceModelMetricItemRequestTypeEnum to String, and decode dynamic data back to DeviceModelMetricItemRequestTypeEnum.
DeviceModelMetricItemResponse
DeviceModelMetricItemResponseTypeEnum
DeviceModelMetricItemResponseTypeEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of DeviceModelMetricItemResponseTypeEnum to String, and decode dynamic data back to DeviceModelMetricItemResponseTypeEnum.
DeviceModelMetricItemsApi
DeviceModelRequestBody
DeviceModelRequestBodyData
DeviceModelsApi
DeviceRequestBody
DeviceRequestBodyData
DevicesApi
DeviceStatusEnum
DeviceStatusEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of DeviceStatusEnum to String, and decode dynamic data back to DeviceStatusEnum.
Error
Gateway
GatewayAssignLicenseRequestBody
GatewayAssignLicenseRequestBodyData
GatewayDisconnectLicenseRequestBody
GatewayDisconnectLicenseRequestBodyData
GatewayModel
GatewayModelRequestBodyData
GatewayModelsApi
GatewayModelsRequestBody
GatewayRequestBody
GatewayRequestBodyData
GatewaysApi
GatewayStatus
GroupsApi
IngestionConfig
License
LicenseGateway
LicenseRegisterWithTokenRequestBody
LicenseRequestAssignBody
LicenseRequestBodyItem
LicenseRequestDisconnectBody
LicensesApi
Manufacturer
ManufacturerRequestBodyData
ManufacturersApi
ManufacturersRequestBody
MetricCategory
MetricCategoryTypeAssetsTransformer
AssetsTransformation class that can encode an instance of MetricCategory to String, and decode dynamic data back to MetricCategory.
MetricPermission
permissions: 0 = read, 1 = write, 2 = read+write
MetricPermissionTypeAssetsTransformer
AssetsTransformation class that can encode an instance of MetricPermission to int, and decode dynamic data back to MetricPermission.
MetricResponse
ModbusRTURequestBody
ModbusRTURequestBodyTypeEnum
ModbusRTURequestBodyTypeEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of ModbusRTURequestBodyTypeEnum to String, and decode dynamic data back to ModbusRTURequestBodyTypeEnum.
Plant
PlantBasic
PlantPostRequestBody
PlantRequestBodyData
PlantsApi
PopulateDeviceModelQueryParameters
retain policy tag
PopulateDeviceQueryParameters
retain policy tag
PopulateFieldsQueryParameters
retain policy tag
PopulateGatewayQueryParameters
retain policy tag
PopulateGroupQueryParameters
retain policy tag
PopulateLicenseQueryParameters
retain policy tag
PopulatePlantQueryParameters
retain policy tag
PopulateQueryParam
PopulateTransformsQueryParameters
retain policy tag
RequestConnectDisconnectBody
RequestConnectDisconnectBodyData
RetPolicy
retain policy tag
RetPolicyTypeAssetsTransformer
AssetsTransformation class that can encode an instance of RetPolicy to String, and decode dynamic data back to RetPolicy.
SpecialUuid
StaticTag
StatusEnum
StatusEnumTypeAssetsTransformer
AssetsTransformation class that can encode an instance of StatusEnum to String, and decode dynamic data back to StatusEnum.
SupportedGateway
SupportedGatewayRequestBody
SupportedGatewaysApi
Tags
Unit
unit: from International System of Units (SI)
UnitTypeAssetsTransformer
AssetsTransformation class that can encode an instance of Unit to String, and decode dynamic data back to Unit.

Properties

authenticator ↔ LogbotHttpBearerAuth
getter/setter pair
defaultApiClient ApiClient
getter/setter pair

Functions

decodeAsync(DeserializationMessage message) Future
Primarily intended for use in an isolate.
deserializeAsync(DeserializationMessage message) Future
Primarily intended for use in an isolate.
mapCastOfType<K, V>(dynamic map, String key) Map<K, V>?
Returns a valid Map<K, V> found at the specified Map key, null otherwise.
mapDateTime(dynamic map, String key, [String? pattern]) DateTime?
Returns a valid DateTime found at the specified Map key, null otherwise.
mapValueOfType<T>(dynamic map, String key) → T?
Returns a valid T value found at the specified Map key, null otherwise.
parameterToString(dynamic value) String
Format the given parameter object into a String.
serializeAsync(Object? value) Future<String>
Primarily intended for use in an isolate.