public interface DeviceApi
| Modifier and Type | Method and Description |
|---|---|
rx.Observable<retrofit.client.Response> |
checkDevicePermission(java.lang.String deviceId,
java.lang.String action)
Checks device permission
|
rx.Observable<Device> |
createDevice(CreateDevice device)
Creates device on the platform.
|
rx.Observable<java.lang.Void> |
deleteDevice(java.lang.String deviceId)
Deletes a device from platform.
|
rx.Observable<java.lang.Void> |
deleteMetadata(java.lang.String deviceId,
java.lang.String key)
Returns device's
StateMetadata |
rx.Observable<JsonListResponse<Device>> |
getAllDevices(java.lang.Integer pageNumber,
java.lang.Integer pageSize,
java.lang.String deviceIds,
java.lang.String modelId,
java.lang.String firmwareVersion,
java.lang.String deviceName,
java.lang.String deviceDescription)
Returns all user devices.
|
rx.Observable<StateCommands> |
getCommands(java.lang.String deviceId,
java.lang.String path,
java.lang.String name)
Deprecated.
|
rx.Observable<StateConfigurations> |
getConfigurations(java.lang.String deviceId,
java.lang.String path,
java.lang.String name)
Deprecated.
|
rx.Observable<Device> |
getDevice(java.lang.String deviceId)
Creates device on the platform.
|
rx.Observable<JsonListResponse<LastCommands>> |
getLastCommands(java.lang.String deviceId,
java.lang.String deviceIds,
java.lang.String path,
java.lang.String name)
Returns device's
StateCommands
Path and name parameters are optional. |
rx.Observable<JsonListResponse<LastConfigurations>> |
getLastConfigurations(java.lang.String deviceId,
java.lang.String path,
java.lang.String name)
Returns device's
StateConfigurations
Path and name parameters are optional. |
rx.Observable<JsonListResponse<LastReadings>> |
getLastReadings(java.lang.String deviceId,
java.lang.String deviceIds,
java.lang.String path,
java.lang.String meaning)
Returns device's
StateReadings
Path and meaning parameters are optional. |
rx.Observable<StateMetadata> |
getMetadata(java.lang.String deviceId,
java.lang.String key)
Returns device's
StateMetadata |
rx.Observable<java.util.List<Device>> |
getPublicDevices(java.lang.String meaning)
A public device is a device which public attribute has been set to 'true' therefore
no authorization is required.
|
rx.Observable<StateReadings> |
getReadings(java.lang.String deviceId,
java.lang.String path,
java.lang.String meaning)
Deprecated.
|
rx.Observable<State> |
getState(java.lang.String deviceId)
Returns device's
State. |
rx.Observable<java.lang.Void> |
sendCommand(java.lang.String deviceId,
Command command)
Send command defined by device models
DeviceCommand
Before sending a command make sure to validate it by calling Action.validate(ValueSchema) |
rx.Observable<java.lang.Void> |
sendConfiguration(java.lang.String deviceId,
Configuration configuration)
Sets device configuration defined by device models
DeviceConfiguration
Before sending a command make sure to validate it by calling Action.validate(ValueSchema) |
rx.Observable<java.lang.Void> |
setMetadata(java.lang.String deviceId,
java.lang.String key,
java.lang.Object metadata)
Persists user defined object in device state
State metadata |
rx.Observable<Device> |
updateDevice(java.lang.String deviceId,
Device device)
Updates a device.
|
@GET(value="/devices/{id}")
rx.Observable<Device> getDevice(@Path(value="id")
java.lang.String deviceId)
deviceId - of device to fetch@GET(value="/devices") rx.Observable<JsonListResponse<Device>> getAllDevices(@Query(value="page_number") java.lang.Integer pageNumber, @Query(value="page_size") java.lang.Integer pageSize, @Query(value="device_ids") java.lang.String deviceIds, @Query(value="model_id") java.lang.String modelId, @Query(value="firmware_version") java.lang.String firmwareVersion, @Query(value="device_name") java.lang.String deviceName, @Query(value="device_description") java.lang.String deviceDescription)
pageNumber - - the page number, starting with 0pageSize - - how many items are returned per pagedeviceIds - - a comma separated list of device IdsmodelId - - a model id used by the devices or the keyword 'any' for all devices that have a modelfirmwareVersion - - the firmware version of the searched devicesdeviceName - - a partial name of the devicesdeviceDescription - - a partial description of the devices@POST(value="/devices") rx.Observable<Device> createDevice(@Body CreateDevice device)
device - to create@PATCH(value="/devices/{id}")
rx.Observable<Device> updateDevice(@Path(value="id")
java.lang.String deviceId,
@Body
Device device)
deviceId - id of the device to updatedevice - updated device with the new detailsObservable to the updated Device@DELETE(value="/devices/{id}")
rx.Observable<java.lang.Void> deleteDevice(@Path(value="id")
java.lang.String deviceId)
deviceId - id of device to delete@GET(value="/devices/{id}/permissions/{action}")
rx.Observable<retrofit.client.Response> checkDevicePermission(@Path(value="id")
java.lang.String deviceId,
@Path(value="action")
java.lang.String action)
deviceId - - UUID of the device to checkaction - - 'read', 'write' or 'admin'@GET(value="/devices/public") rx.Observable<java.util.List<Device>> getPublicDevices(@Query(value="meaning") java.lang.String meaning)
meaning - When a meaning is specified, the request returns only
the devices which readings match the meaning.Observable with a list of all public devices.@POST(value="/devices/{id}/commands")
rx.Observable<java.lang.Void> sendCommand(@Path(value="id")
java.lang.String deviceId,
@Body
Command command)
DeviceCommand
Before sending a command make sure to validate it by calling Action.validate(ValueSchema)@POST(value="/devices/{id}/configurations")
rx.Observable<java.lang.Void> sendConfiguration(@Path(value="id")
java.lang.String deviceId,
@Body
Configuration configuration)
DeviceConfiguration
Before sending a command make sure to validate it by calling Action.validate(ValueSchema)@POST(value="/devices/{id}/metadata")
rx.Observable<java.lang.Void> setMetadata(@Path(value="id")
java.lang.String deviceId,
@Query(value="key")
java.lang.String key,
@Body
java.lang.Object metadata)
State metadatadeviceId - unique device identifierkey - unique key in metadata dictionarymetadata - user defined object@GET(value="/devices/{id}/state")
rx.Observable<State> getState(@Path(value="id")
java.lang.String deviceId)
State.
Device state shows latest state of devices' readings, configuration, commands and metadata.deviceId - unique device identifier@GET(value="/devices/{id}/metadata")
rx.Observable<StateMetadata> getMetadata(@Path(value="id")
java.lang.String deviceId,
@Query(value="key")
java.lang.String key)
StateMetadatadeviceId - unique device identifierkey - key to filter metadata dictionary@DELETE(value="/devices/{id}/metadata")
rx.Observable<java.lang.Void> deleteMetadata(@Path(value="id")
java.lang.String deviceId,
@Query(value="key")
java.lang.String key)
StateMetadatadeviceId - unique device identifierkey - key to filter metadata dictionary@Deprecated
@GET(value="/devices/{id}/readings")
rx.Observable<StateReadings> getReadings(@Path(value="id")
java.lang.String deviceId,
@Query(value="path")
java.lang.String path,
@Query(value="meaning")
java.lang.String meaning)
StateReadings
Path and meaning parameters are optional. If provided used as regular filter fields.deviceId - unique device identifierpath - defined by DeviceReading.getPath() in DeviceModelmeaning - defined by DeviceReading.getMeaning() in DeviceModel@GET(value="/devices/readings") rx.Observable<JsonListResponse<LastReadings>> getLastReadings(@Path(value="id") java.lang.String deviceId, @Query(value="deviceIds") java.lang.String deviceIds, @Query(value="path") java.lang.String path, @Query(value="meaning") java.lang.String meaning)
StateReadings
Path and meaning parameters are optional. If provided used as regular filter fields.deviceIds - list of device Ids separated by commaspath - defined by DeviceReading.getPath() in DeviceModelmeaning - defined by DeviceReading.getMeaning() in DeviceModel@Deprecated
@GET(value="/devices/{id}/commands")
rx.Observable<StateCommands> getCommands(@Path(value="id")
java.lang.String deviceId,
@Query(value="path")
java.lang.String path,
@Query(value="name")
java.lang.String name)
StateCommands
Path and name parameters are optional. If provided used as regular filter fields.deviceId - unique device identifierpath - defined by DeviceCommand.getPath() in DeviceModelname - defined by DeviceCommand.getName() in DeviceModel@GET(value="/devices/commands") rx.Observable<JsonListResponse<LastCommands>> getLastCommands(@Path(value="id") java.lang.String deviceId, @Query(value="deviceIds") java.lang.String deviceIds, @Query(value="path") java.lang.String path, @Query(value="name") java.lang.String name)
StateCommands
Path and name parameters are optional. If provided used as regular filter fields.deviceIds - list of device Ids separated by commaspath - defined by DeviceCommand.getPath() in DeviceModelname - defined by DeviceCommand.getName() in DeviceModel@Deprecated
@GET(value="/devices/{id}/configurations")
rx.Observable<StateConfigurations> getConfigurations(@Path(value="id")
java.lang.String deviceId,
@Query(value="path")
java.lang.String path,
@Query(value="name")
java.lang.String name)
StateConfigurations
Path and name parameters are optional. If provided used as regular filter fields.deviceId - unique device identifierpath - defined by DeviceConfiguration.getPath() in DeviceModelname - defined by DeviceConfiguration.getName() in DeviceModel@GET(value="/devices/configurations") rx.Observable<JsonListResponse<LastConfigurations>> getLastConfigurations(@Path(value="id") java.lang.String deviceId, @Query(value="path") java.lang.String path, @Query(value="name") java.lang.String name)
StateConfigurations
Path and name parameters are optional. If provided used as regular filter fields.deviceId - unique device identifierpath - defined by DeviceConfiguration.getPath() in DeviceModelname - defined by DeviceConfiguration.getName() in DeviceModel