<< Click to Display Table of Contents >> Navigation: API Connectors/Client Side > Integration Guide |
For the first steps in getting the Gateway up and running, you can follow the steps below. It is just a rough guideline and gives you an overview of the necessary implementation steps.
Step |
Goal |
JSON API |
Simple API |
Remarks |
---|---|---|---|---|
1 – Identify |
Identify the right API |
IP Clients with full TCP/IP Stack and “JSON” libraries •Windows •Unix •MacOs •etc.
|
Industrial Controllers i.e. •Siemens •Crestron •AMX •WAGO •Beckhoff •Loxone •etc…
|
|
2 – Device Learn in |
Learn in EnOcean devices |
Via Administrator API: |
- |
Is achieved through Browser User Interface http://<IP-Gateway> |
3 – Connect |
Real-Time Connection |
Two threads in client application besides main(): •Receiving Events from the Gateway -> Streaming API •Sending Events to the Gateway -> “Keep-alive” connection |
One thread in client application besides main(): |
|
4 – Device Info |
Get Infos about the Learned in devices |
Command: |
Command: |
No functional difference between APIs |
5 – Profile Info |
Get Profile Infos per Device |
Command: |
Not Available |
Issue Command for each device to get the profile Information |
6 – Modules |
Build Modules per Profile |
Get the Key Value Pairs associated to each profile and build modules/encapsulations for each profile and/or to the function blocs within more complex profiles. Command: •GET /devices/{deviceId}/profile.pdf •or •GET /profiles/{eepid}.pdf (ex. GET/profiles/F6-02-01.pdf)
|
Not Available |
The returned key/Value pairs are nicer for human reading and understanding the profile. The data corresponds to the returned JSON description of GET /profile in Step 5. You can also build a generator for the modules if you run it against the JSON output of all profiles. |
7 – Run |
Let the application run |
|
|
You should have full control over events and actions in the EnOcean World. |