Package

com.ubirch.avatar.model.rest

device

Permalink

package device

Visibility
  1. Public
  2. All

Type Members

  1. case class AvatarDraft(id: String, ┬║stateDesired: Option[JValue], stateReported: Option[JValue], created: Option[DateTime], updated: Option[DateTime], lastActive: Option[DateTime]) extends Product with Serializable

    Permalink

    we might use this draft in the future

  2. case class AvatarState(deviceId: String, inSync: Option[Boolean] = None, desired: Option[JValue] = None, reported: Option[JValue] = None, delta: Option[JValue] = None, deviceLastUpdated: Option[DateTime] = ..., avatarLastUpdated: Option[DateTime] = ...) extends Product with Serializable

    Permalink

    author: cvandrei since: 2017-06-16

    author: cvandrei since: 2017-06-16

    deviceId

    id of associated device, should be a UUID

    inSync

    means reported == desired

    desired

    json with changed device config and states from other sensors (actor -> sensor)

    reported

    last state as reported by device

    delta

    delta state = reported - desired

    deviceLastUpdated

    timestamp of last reported state update

    avatarLastUpdated

    timestamp of last desired state update

  3. case class DeviceDataRaw(id: UUID = UUIDUtil.uuid, uuid: Option[String] = None, v: String = MessageVersion.v003, fw: String = "n.a.", a: String, ts: DateTime = DateTime.now(), k: Option[String] = None, s: Option[String] = None, p: JValue, deviceId: Option[String] = None, deviceName: Option[String] = None, chainedHash: Option[String] = None, txHash: Option[String] = None, txHashLink: Option[String] = None, txHashLinkHtml: Option[String] = None) extends Product with Serializable

    Permalink

    Payload could contain e, which contains a error message

    Payload could contain e, which contains a error message

    author: derMicha since: 2016-10-28

    v

    message type version

    a

    hashed hardware deviceId

    ts

    timestamp

    k

    public key

    s

    hashed auth token or public key

    p

    payload

    txHash

    optional hash of related blockchain anchor

  4. case class DeviceDataRawEnvelope(validationState: String, deviceMessage: DeviceDataRaw, signature: Option[String], timestamp: DateTime = DateTime.now()) extends Product with Serializable

    Permalink
  5. case class DeviceDataV3(c: JValue, d: JValue) extends Product with Serializable

    Permalink
  6. case class DeviceDraft(id: String, name: Option[String], hwType: Option[String], hwId: Option[String], syncState: Option[Int], tags: Option[Set[String]], properties: Option[JValue], subscriptions: Option[Set[String]], config: Option[JValue], avatar: Option[AvatarDraft], created: Option[DateTime], updated: Option[DateTime], lastActive: Option[DateTime]) extends Product with Serializable

    Permalink

    we might use this draft in the future

  7. case class DeviceHistory(messageId: UUID, deviceDataRawId: UUID, deviceId: String, deviceName: String, deviceType: String, deviceTags: Set[String], deviceMessage: JValue, deviceDataRaw: Option[DeviceDataRaw] = None, timestamp: DateTime) extends Product with Serializable

    Permalink

    author: cvandrei since: 2016-11-02

  8. case class DeviceHistoryLegacy(messageId: UUID, deviceDataRawId: UUID, deviceId: String, deviceName: Option[String] = None, deviceType: String, deviceTags: Set[String], deviceMessage: JValue, deviceDataRaw: Option[DeviceDataRaw] = None, timestamp: DateTime) extends Product with Serializable

    Permalink
  9. final case class DeviceInfo(deviceId: String, deviceName: String, deviceTypeKey: String = "unknownDeviceType", deviceLastUpdated: Option[DateTime], inSync: Option[Boolean]) extends Product with Serializable

    Permalink

    Created by derMicha on 07/11/16.

  10. case class DeviceStateUpdate(id: UUID = UUIDUtil.uuid, v: String = MessageVersion.v002, k: String, s: String, p: JValue, ts: DateTime = DateTime.now) extends Product with Serializable

    Permalink

    Payload could contain e, which contains a error message

    Payload could contain e, which contains a error message

    author: derMicha since: 2016-10-28

    v

    message type version

    k

    public key

    s

    hashed auth token or public key

    p

    payload

    ts

    timestamp

  11. case class DeviceType(key: String, name: DeviceTypeName, icon: String, displayKeys: Option[Array[String]] = Some(Array.empty), transformerQueue: Option[String] = None, defaults: DeviceTypeDefaults) extends Product with Serializable

    Permalink

    author: derMicha since: 2016-10-28.

    author: derMicha since: 2016-10-28.

    key

    unique descriptive id which identifies the current DeviceType

    name

    human readable name

    defaults

    default properties of a device

  12. case class DeviceTypeDefaults(properties: JValue, config: JValue, tags: Set[String]) extends Product with Serializable

    Permalink
  13. case class DeviceTypeName(de: String, en: String) extends Product with Serializable

    Permalink
  14. case class PayloadV3(c: JValue, p: Array[JValue]) extends Product with Serializable

    Permalink
  15. case class TransformedDeviceMessage(version: String = MessageVersion.v003, messageId: UUID = UUIDUtil.uuid, deviceId: String, validationState: Option[String], signature: Option[String], simpleDeviceMessageRefId: UUID, error: Option[String], config: JValue, payload: JValue, timestamp: Option[DateTime] = None) extends Product with Serializable

    Permalink

    Created by derMicha on 28/10/16.

    Created by derMicha on 28/10/16.

    version

    verison Id which identifies the version of the message type

    messageId

    unique message id

    deviceId

    id of the device which sends the message

    simpleDeviceMessageRefId

    refers to original DeviceDataRaw

    error

    device error message

    config

    device config

    payload

    data as JSON / JValue

    timestamp

    timestamp of the original DeviceDataRaw

Ungrouped