Report a sensor reading and detect alarm transitions
Edge-detects an alarm transition for a single sensor channel and emits AlarmTriggered / AlarmCleared (or NO_EVENT when unchanged).
curl -X POST "https://api.spkey.co/matter-devices/example_string/ReportSensorState" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"channel": "boolean_state",
"matterPath": "example_string",
"value": 3.14,
"deviceTypeId": 123,
"endpoint": 42,
"deviceTypeSource": "shadow",
"timestamp": "example_string"
}'
import requests
import json
url = "https://api.spkey.co/matter-devices/example_string/ReportSensorState"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"channel": "boolean_state",
"matterPath": "example_string",
"value": 3.14,
"deviceTypeId": 123,
"endpoint": 42,
"deviceTypeSource": "shadow",
"timestamp": "example_string"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.spkey.co/matter-devices/example_string/ReportSensorState", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"channel": "boolean_state",
"matterPath": "example_string",
"value": 3.14,
"deviceTypeId": 123,
"endpoint": 42,
"deviceTypeSource": "shadow",
"timestamp": "example_string"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"channel": "boolean_state",
"matterPath": "example_string",
"value": 3.14,
"deviceTypeId": 123,
"endpoint": 42,
"deviceTypeSource": "shadow",
"timestamp": "example_string"
}`)
req, err := http.NewRequest("POST", "https://api.spkey.co/matter-devices/example_string/ReportSensorState", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.spkey.co/matter-devices/example_string/ReportSensorState')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
"channel": "boolean_state",
"matterPath": "example_string",
"value": 3.14,
"deviceTypeId": 123,
"endpoint": 42,
"deviceTypeSource": "shadow",
"timestamp": "example_string"
}'
response = http.request(request)
puts response.body
{
"success": true,
"aggregateId": "example_string",
"version": 3.14,
"event": {
"type": "AlarmTriggered",
"data": {
"deviceId": "example_string",
"channel": "boolean_state",
"alarmType": "contact",
"severity": "warning",
"matterPath": "example_string",
"deviceTypeId": 123,
"endpoint": 42,
"deviceTypeSource": "shadow",
"rawValue": 3.14,
"timestamp": "example_string"
}
}
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
/matter-devices/{id}/ReportSensorStateTarget server for requests. Edit to use your own host.
JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API key for B2B organization access. Provided during organization onboarding.
Matter Device ID
The media type of the request body
Which sensor channel this reading is for
Full Matter endpoint/cluster/attribute path, e.g. "1/69/0" or "2/92/0"
Reported value (0/1 boolean state, 0-8 ExpressedState, 0/1/2 AlarmStateEnum, occupancy bitmap)
Matter device type id (29/0) — required to interpret boolean_state
Matter endpoint the attribute was found on (sensors are not always on 1)
Provenance of deviceTypeId — shadow / sticky D1 projection / caller
ISO timestamp of the reading
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Path Parameters
Matter Device ID
Body
Which sensor channel this reading is for
boolean_statesmokesmoke_interconnectcooccupancydevice_faultFull Matter endpoint/cluster/attribute path, e.g. "1/69/0" or "2/92/0"
Reported value (0/1 boolean state, 0-8 ExpressedState, 0/1/2 AlarmStateEnum, occupancy bitmap)
Matter device type id (29/0) — required to interpret boolean_state
Matter endpoint the attribute was found on (sensors are not always on 1)
Provenance of deviceTypeId — shadow / sticky D1 projection / caller
shadowstickycommandshadow_borrowedshadow_disputedISO timestamp of the reading
Responses
Emitted transition event, or null when the reading caused no transition