Lightbug Documentation
Search K

Appearance

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

GET
/devices/id/queueRtkCmd_AlertWithPrompt

Parameters​

Path Parameters

id*

device id

Typenumber
Required
formatinteger

Query Parameters

alertValue*

Refer to documentation for structure of 4 byte alert value

Typenumber
Required
format
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
format

Responses​

Body (JSON)
application/json
JSON
{
"deviceId": 0,
"messageId": 0,
"commandType": 0,
"created": "string",
"sent": "string",
"receivedAck": "string",
"payload": "string",
"response": "string",
"id": 0
}

Samples​

cURL
curl -X GET \
'https://api.lightbug.cloud/api/devices/id/queueRtkCmd_AlertWithPrompt' \
 -H "Content-Type: application/json"
JavaScript
fetch('https://api.lightbug.cloud/api/devices/id/queueRtkCmd_AlertWithPrompt', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));
PHP
<?php
$url = 'https://api.lightbug.cloud/api/devices/id/queueRtkCmd_AlertWithPrompt';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
Python
import requests

url = 'https://api.lightbug.cloud/api/devices/id/queueRtkCmd_AlertWithPrompt'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())