cloud.smarthq.service.pizzaoven.reminders¶

State

A list of the states this service can be in.

Go There
Commands

How to change the state of the service.

Go There
Data Types

All the data types used for this service.

Go There

Description¶

Service for the Pizza Oven reminders

Example Device Response (Digital Twin API)¶

Pizza Oven Reminders Status.

{
  "adapterId": "0000000000000000000000000000000000000000",
  "alertTypes": [],
  "createdDateTime": "2022-03-04T12:12:12.123Z",
  "deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
  "deviceType": "cloud.smarthq.device.pizzaoven",
  "gatewayId": "0000000000000000000000000000000000000000000000000000000000000000",
  "kind": "device#item",
  "lastPresenceTime": "2022-03-04T12:12:12.123Z",
  "lastSyncTime": "2022-03-04T12:12:12.123Z",
  "presence": "OFFLINE",
  "removable": true,
  "services": [
    {
      "serviceType": "cloud.smarthq.service.pizzaoven.reminders",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.reminders",
      "supportedCommands": [
        "cloud.smarthq.command.pizzaoven.reminders.set"
      ],
      "state": {
        "pizzaRotateReminder": "cloud.smarthq.type.reminder.status.enabled",
        "pizzaFinalCheckReminder": "cloud.smarthq.type.reminder.status.disabled",
        "pizzaDoneReminder": "cloud.smarthq.type.reminder.status.disabled"
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.pizzaoven",
      "config": {},
      "lastStateTime": "2022-03-04T12:12:12.123Z"
    }
  ],
  "userId": "000000000000000"
}

State¶

The following are properties for the device state report as part of the "state" object for each individual service.

Field Name	Property Type	Required
disabled	BOOLEAN	No
pizzaDoneReminder	REMINDER_STATUS	Yes
pizzaFinalCheckReminder	REMINDER_STATUS	Yes
pizzaRotateReminder	REMINDER_STATUS	Yes

Commands¶

The following are properties for both the Digital Twin API to send a command to the device as well as the properties passed as part of a command to the gateway to be processed by the device itself.

cloud.smarthq.command.pizzaoven.reminders.set¶

Command used to set the reminders status on the pizza oven.

Field Name	Property Type	Required
pizzaDoneReminderValue	REMINDER_STATUS	Yes
pizzaFinalCheckReminderValue	REMINDER_STATUS	Yes
pizzaRotateReminderValue	REMINDER_STATUS	Yes

Example Commands¶

Command used to set the reminders status on the pizza oven.

{
  "command": {
    "commandType": "cloud.smarthq.command.pizzaoven.reminders.set",
    "pizzaDoneReminderValue": "cloud.smarthq.type.reminder.status.disabled",
    "pizzaRotateReminderValue": "cloud.smarthq.type.reminder.status.enabled",
    "pizzaFinalCheckReminderValue": "cloud.smarthq.type.reminder.status.enabled"
  },
  "deviceId": "00000000000000000000000000000000000000000000000000000000000000",
  "domainType": "cloud.smarthq.domain.reminders",
  "kind": "service#command",
  "serviceDeviceType": "cloud.smarthq.device.pizzaoven",
  "serviceType": "cloud.smarthq.service.pizzaoven.reminders"
}

Supported Outcomes¶

Each service has an allow listed set of outcomes that the device may return when asked to execute a command.

Outcome	Documentation
cloud.smarthq.outcome.badrequest	The request was invalid.
cloud.smarthq.outcome.developererror	Only used when there is a server side bug
cloud.smarthq.outcome.deviceoffline	The device is offline.
cloud.smarthq.outcome.forbidden	The request is forbidden due to permissions.
cloud.smarthq.outcome.internalerror	The server had an issue processing the request
cloud.smarthq.outcome.missingconfig	The service config is missing
cloud.smarthq.outcome.missingstate	The service state is missing
cloud.smarthq.outcome.notallowed	The command is not allowed.
cloud.smarthq.outcome.notfound	The request is forbidden due to permissions.
cloud.smarthq.outcome.notsupported	The command is not supported.
cloud.smarthq.outcome.servicedisabled	Feature is currently disabled
cloud.smarthq.outcome.success	Successful request
cloud.smarthq.outcome.timeout	The server experienced timeout waiting for a response from the gateway

Data Types¶

BOOLEAN¶

Value must be either true or false.

REMINDER_STATUS¶

REMINDER_STATUS	Documentation
cloud.smarthq.type.reminder.status.disabled	Disabled
cloud.smarthq.type.reminder.status.enabled	Enabled