PUT /devices/{deviceId}/learnIn

<< Click to Display Table of Contents >>

Navigation:  The API > JSON Adminstrator API > REST Resources > Devices > PUT >

PUT /devices/{deviceId}/learnIn

LearnIn

The call sends out a learnIn telegram to bidirectional devices, which are not using UTE, SmartAck or 4BS-TeachIn Variation 3 as Learn-in procedure.

LearnIn Telegrams to be sent out this way are:

oreceivedRps

oreceived1Bs

oreceived4Bs

The function can only be called for devices that have an already set EEP-Value, from which the gateway knows the learnIn telegram to be sent out.

These devices have to be manually set to listen to learnIn telegrams by the user, before sending out this telegram.

 

Client to Gateway:

Resource Path

HTTP method

/devices/{deviceId}/learnIn

PUT

 

Necessary  call parameters:

parameter

datatype

value / formatting

description

header

object

{}

standard header object with content = learnIn

learnIn

object

{}

learnIn object

 

deviceId

string

deviceId

 

 

mode
(optional)

string

firstButton | secondButton

Only used when sending a RPS telegram.

 

eep

string

xx-xx-xx
based on receivedRps | received1Bs | received4Bs

EnOcean Equipment Profiles, definition of Enocean radio telegram structure

 

 

example:

The example shows the request for the gateway to send out a learnIn telegram to a already known device.

 

Basic structure of gateway call:

 

http://hostname:api_port/{deviceId}/learnIn
 
{

  "learnIn" : {

    "deviceId" : "00290FE2",

    "mode" : "secondButton",

    "eep" : "F6-02-01"

  }

}