Overview
EnOcean API
Functionality/Purpose of the Gateway
The Gateway
Product
Quickstart Guide
Discovery of the Gateway
Manual
Functions and Profiles
Learn-In Procedures
SmartAck vs. Soft Smart Ack vs. 4BS Teach-in Variation 3
The API
API Overview
API function calls
Last States
JSON vs. Simple String
Key Values pairs
From Gateway to Client
From Client to Gateway
JSON description
PDF description
HTML description
JSON API
Security
HTTP Basic Authentication
TLS Encryption
Communication design
Synchronous Communication with Keep-alive
Synchronous Communication with Streaming API
Asynchronous Communication
Real Time Communication
From Gateway to Client: Streaming API
Connecting to a streaming Endpoint
Streaming API request parameters
Streaming message types
Processing streaming data
From Client to Gateway: Persistent Connection
Http Keep Alive
Streaming REST filter
REST Resources
JSON Resource endpoint
Devices
GET
GET /devices
GET /devices?newDevice=true
GET /devices/states
GET /devices/stream
GET /devices/telegrams
GET /devices/{deviceId}
GET /devices/{deviceId}/profile
GET /devices/{deviceId}/profile.html
GET /devices/{deviceId}/profile.pdf
GET /devices/{deviceId}/state
GET /devices/{deviceId}/stream
GET /devices/{deviceId}/telegrams
PUT
PUT /devices/{deviceId}/state
Profiles
GET
GET /profiles
GET /profiles/{eepId}
GET /profiles/{eepId}.html
GET /profiles/{eepId}.pdf
System
Systeminfo
HTTP Response Codes
Gateway Response Codes
JSON Adminstrator API
Understanding the admin API
Learning in a new device
Streaming Admin API vs Streaming API
Streaming message types
Devices
Device
Telegram
REST Resources
Devices
GET
GET /devices
GET /devices/stream
GET /devices/{deviceId}
GET /devices?newDevice=true
GET /device/{deviceId}/profile
PUT
PUT /devices/{deviceId}/test
PUT /devices/{deviceId}/learnIn
POST
POST /devices/{deviceId}
Internet of Things Device
IoT Label
POST /devices/ (iot)
QR Code for existing Sensors
Create an existing device
DELETE
DELETE /devices/{deviceId}
Profiles
GET
GET /profiles
GET /profiles/{eepId}
System
GET
GET /system/receiveMode
POST
POST /system/receiveMode
Reference Client Administrator API
Simple API
Security
Basic Authentication
TLS Encryption
Communication Design
String basics
From JSON profiles to Simple API Commands
Messages from Gateway
state;
telegram;
Functions format
From Gateway to Client
From Client to Gateway
Commands to Gateway
date;
devices;
help;
login;
send;
set;
state;
systeminfo;
version;
API Connectors/Client Side
Integration Guide
Examples for sending commands
Permundo actuator PSC 234
JSON API
Simple API
Available Clients
Java Reference Client
Crestron Modules