<< Click to Display Table of Contents >> Navigation:  The API > Simple API > From JSON profiles to Simple API Commands

Overview

 

As the simple API and the JSON API transfer the same information for the use of the devices, all Key-Value pairs of a profile for the control of the EnOcean devices exist on both APIs

Identifying the Key-Value pairs for a specific profile

For a specific profile, please have a look at the GET /profiles/{eepid}.pdf function. All Key-Value pairs that are part of one Command Set are grouped together. Keys are valid on both APIs so you can use them in Simple API as well.

Example

If you are looking for the syntax for the profile A5-04-01 in order to make a module for it, then follow these steps:

•Identify the Key-Value pairs

oGET /profiles/A5-04-01.pdf

oIt´s a "from" profile where Values are only transmitted from the device

oKeys are:

▪"humidity"; range 0-100 with a step of 0.4

▪"temperature"; range 0-40 with a step of 0.2

 

 

If you are looking for the syntax for the profile D2-01-09 in order to make a module for it, then follow these steps:

•Identify the Key-Value pairs

oGET /profiles/D2-01-09.pdf

 

•There are now several command groups where each group has a set of Key-Value pairs

o"To" Groups:

 

▪Actuator Set Output

•Keys are:

o"dimValue", range 0-100, step 1

o"rampingMode", range 0-4

•A valid Simple API command would be

osend;deviceID=18934F2B;dimValue=50;rampingMode=2

 

 

▪Actuator Set Local

•Keys are:

o"defaultState", range 0-2

o"dimTimer1", range 0.5-7.5, step 0.5

o"dimTimer2", range 0.5-7.5, step 0.5

o"dimTimer3", range 0.5-7.5, step 0.5

o"overcurrentSwitchOffReset", range 0-1

o"taughtInDevices", range 0-1

•A valid Simple API command would be

osend;deviceID=18934F2B;defaultState=1;dimTimer1=2;dimTimer2=4;dimTimer3=6;dimTimer1=2;overcurrentSwitchOffReset=2;taughtInDevices=0

 

.... and so on.....