Trigger a prompt now on the device (response sent via MQTT)

GET

/devices/id/queueRtkCmd_AlertWithPrompt

Parameters

Path Parameters

id*

device id

Typenumber

Required

Query Parameters

alertValue*

Refer to documentation for structure of 4 byte alert value

Typenumber

Required

prompt*

Text to display on device. Long text will be scrolled automatically but try to keep it short!

Typestring

Required

btn1Text

Text to display above left(up) arrow button

Typestring

btn2Text

Text to display above right(down) arrow button

Typestring

timeoutS

if non-zero, auto hide message after this many seconds

Typenumber

Responses

Body (JSON)

Content-Type

{

"deviceId": 0,

"messageId": 0,

"commandType": 0,

"created": "string",

"sent": "string",

"receivedAck": "string",

"payload": "string",

"response": "string",

"id": 0

}

GET

/devices/id/queueRtkCmd_AlertWithPrompt

Samples

cURL

curl -X GET https://api.lightbug.cloud/api/devices/id/queueRtkCmd_AlertWithPrompt

JavaScript

fetch("https://api.lightbug.cloud/api/devices/id/queueRtkCmd_AlertWithPrompt")
  .then(response => response.json())
  .then(data => console.log(data));

PHP

file_get_contents("https://api.lightbug.cloud/api/devices/id/queueRtkCmd_AlertWithPrompt");

Python

import requests
response = requests.get("https://api.lightbug.cloud/api/devices/id/queueRtkCmd_AlertWithPrompt")
print(response.json())