background image

 

You can add up to five custom headers 

 
For instance, if you added a header named “Token” with value “

sdffsWED34sdfFG6wddV3”, the headers

 

   

 

   

 

 

 

 

 

 

 

 

sent by Efento Gateway would look like this: 

 

Content-Type: application/json 
charset=UTF-8 
Token: 

sdffsWED34sdfFG6wddV3 

 
Please note, that the messages sent by the server to the gateway may not contain more than ten headers.

 

 

 

 

 

 

 

 

   

 

 

 

 

 

 

 

 

 

Any value above that, will be treated as wrong value and gateway will not accept this message. 

API 

Efento gateway supports two API versions “API v1” and “API v2”. API v1 is deprecated and should no longer

 

 

 

 

 

 

 

 

 

 

 

     

 

 

   

 

be used. API v2 specification: 
 

ENDPOINT 

/api/v2/measurements 
 

(if user set other endpoint in “Custom API endpoint” field, measurements will be sent to

 

 

 

 

   

 

 

 

 

 

 

 

   

that endpoint) 

METHOD 

POST 

HEADERS 

Content-Type: application/json 
charset=UTF-8 
X-Api-Token: 

<value of the “Token” field> 

 
(if user set other headers in “Custom headers” section, user’s custom headers will be

 

 

 

 

   

 

 

 

 

 

 

 

 

added to the headers)

 

 
Http request body contains measurements in a JSON. One message can contain multiple measurements

 

 

 

 

     

 

 

 

 

 

 

 

from one sensor (e.g. if the gateway reestablished the Internet connection and it resends the data) or

 

 

 

   

 

 

 

 

 

 

   

 

 

   

measurements from multiple sensors - if there are few sensors in gateway’s range, gateway will send data

 

 

 

     

 

 

 

   

 

 

 

 

 

 

from multiple sensors in one message. 

 

  "

measurements

" : [ 

        { 

Summary of Contents for Gateway

Page 1: ...Efento Gateway User manual V 1 0 16 07 2020 ...

Page 2: ...af Efento Gateway sends the sensor data over REST protocol HTTPS or HTTP The range of Efento Gateway is up to 100 meters in the open space and 20 30 m in the buildings depending on the building type thickness and material of the walls etc Efento gateway can be configured by the user via a web browser or a free mobile application Technical data WIRELESS COMMUNICATION Communication Bluetooth Low Ene...

Page 3: ...nfiguration 4 Mobile application 4 Web browser 5 Status 5 Sensors 6 Settings 7 Network settings 7 Server settings 8 Sending data to Efento Cloud 8 Sending data to a custom server 9 API 11 Standalone mode 14 Proxy 14 Encryption 14 Password 15 Reset 15 ...

Page 4: ...fento Logger mobile application and press the button on the back of the Efento Gateway twice the button must be pressed with a pin The gateway will switch to configuration mode indicated by a fast flashing blue LED on the gateway s front panel The gateway will appear in the list of available devices in Efento Logger mobile application Select it from the list and key in the password that is on the ...

Page 5: ...formation may be useful when diagnosing a problem or reporting a bug to the Efento support team Status tab Name model firmware version UI version MAC address data used to identify the device along with its name MAC address and software version Local time time set on the device Last connection to server timestamp of the last communication with the server If device has not communicated with server y...

Page 6: ...on if the sensor measurements are buffered in the gateway s memory in case of the connectivity problems gateway will automatically resend the missing measurements and actions icons remove edit Above the table there is search window which allows you to find a sensor by its name and filter buttons that allow you to filter out sensors by their status downloading the data from the sensor s memory ok l...

Page 7: ... it You can leave the default settings of the NTP server pool ntp org or set another server depending on your network requirements Network settings tab Server settings In the server settings tab you can configure the server communication parameters Efento Gateway can send the data to Efento Cloud or any other server cloud platform over REST API Sending data to Efento Cloud If you want to set up yo...

Page 8: ...h Efento Cloud or you want it to synchronise only the measurements from the selected sensors set the Synchronise with server toggle to OFF Go to the Sensors tab and select measurements from which sensors should be synchronised with the server by manually setting the toggles in the Saving column to ON You can manually select which sensors should synchronise the data with Efento Cloud Sending data t...

Page 9: ...s range for some time gateway will download the data from its memory and send it to the server once the connection is reestablished If the gateway was not able to send the data due to Internet connection issues it will also resend it once the connection is reestablished If you do not want the gateway to automatically synchronise the measurements with the server or you want it to synchronise only t...

Page 10: ...nd should no longer be used API v2 specification ENDPOINT api v2 measurements if user set other endpoint in Custom API endpoint field measurements will be sent to that endpoint METHOD POST HEADERS Content Type application json charset UTF 8 X Api Token value of the Token field if user set other headers in Custom headers section user s custom headers will be added to the headers Http request body c...

Page 11: ...e humidity pressure pressure_diff open close value string Examples of the messages sent by Efento Gateway to the server measurements serial 282C024FFFB1 response_handle 1 battery ok signal 70 measured_at 2018 10 12 15 28 21 measurement_interval 180 next_measurement_at 2018 10 12 18 28 21 params channel 1 type temperature value 6 serial 282C024FFFB2 response_handle 2 battery ok signal 70 measured_a...

Page 12: ...type open close value closed Server should always answer with 201 Created to a message sent by Efento Gateway Otherwise the gateway will consider the message as not received by the server and will resend it in a loop Moreover the server should include in the message body the list of the IDs of accepted sensors along with the information if the gateway should synchronize the measurements of these s...

Page 13: ...d non anonymous proxy servers To configure proxy settings go to Proxy tab select proxy type type in server address and port If you selected a non anonymous server key in login credentials Proxy settings Encryption Communication between Efento sensors and Efento Gateway can be encrypted with a key set by the user If the communication is encrypted devices which do not have the encryption key added w...

Page 14: ...recommend changing the password during the gateway configuration Reset In the Reset tab you can Restart the gateway the device will switch off and on again It will not restore the default settings Reset the gateway the device will restore factory default settings All the configuration changes will be lost and you will need to configure the device again ...

Reviews: