EnOcean Link Solution

From ESS-WIKI
Revision as of 08:58, 9 May 2019 by Sam35.lin (talk | contribs) (.)
Jump to: navigation, search

System Architecture:

Rohm light tower sensor demokit 01.png

EnOcean Sensor and Light Tower (chip & demo kit vendor: ROHM)

EnOcean light sensor 01.png

Sensor Communication Protocol:

EnOcean light sensor 03.png

Lighting Condition Data Format:

First 4 bits = pervious status

Last 4 bits = current status

Lighting Condition Value Definition:

0x0 Light off

0x1 Fast blink (0.5s per blink)

0x2 Blinking medium speed (1s per blink)

0x3 Slow flashing (2s per blink)

0x4 Light on

Tower Light Data Format:

EnOcean light sensor 02.png


EnOcean Sample Program:

EnOcean light sensor 04.png


Data type and Data Format:

Agent ID (Sensor ID): String

Sensor Data: Unsigned Integer number

Data Capability in JSON:

{
   "susiCommData":{
      "infoSpec":{
         "SenHub":{
            "SenData":{
               "e":[
                  {
                     "n":"Header",
                     "u":"",
                     "v":0,
                     "min":0,
                     "max":255,
                     "asm":"r",
                     "type":"d",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"ExtendedTelegramType",
                     "u":"",
                     "v":0,
                     "min":0,
                     "max":255,
                     "asm":"r",
                     "type":"d",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"OriginatorID",
                     "u":"",
                     "sv":"",
                     "min":0,
                     "max":0,
                     "asm":"r",
                     "type":"s",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"FwVersion",
                     "u":"",
                     "v":0,
                     "min":0,
                     "max":255,
                     "asm":"r",
                     "type":"d",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"PacketType",
                     "u":"",
                     "v":0,
                     "min":0,
                     "max":15,
                     "asm":"r",
                     "type":"d",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"ActionMode",
                     "u":"",
                     "v":0,
                     "min":0,
                     "max":15,
                     "asm":"r",
                     "type":"d",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"PacketIndex",
                     "u":"",
                     "v":0,
                     "min":0,
                     "max":255,
                     "asm":"r",
                     "type":"d",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"TxType",
                     "u":"",
                     "v":0,
                     "min":0,
                     "max":15,
                     "asm":"r",
                     "type":"d",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"BatteryVoltage",
                     "u":"",
                     "v":0,
                     "min":0,
                     "max":15,
                     "asm":"r",
                     "type":"d",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"Light1",
                     "u":"State",
                     "v":0,
                     "min":0,
                     "max":4,
                     "asm":"r",
                     "type":"d",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"Light2",
                     "u":"State",
                     "v":0,
                     "min":0,
                     "max":4,
                     "asm":"r",
                     "type":"d",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"Light3",
                     "u":"State",
                     "v":0,
                     "min":0,
                     "max":4,
                     "asm":"r",
                     "type":"d",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"Light4",
                     "u":"State",
                     "v":0,
                     "min":0,
                     "max":4,
                     "asm":"r",
                     "type":"d",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"SignalStrength",
                     "u":"dBm",
                     "v":0,
                     "min":0,
                     "max":255,
                     "asm":"r",
                     "type":"d",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  }
               ],
               "bn":"SenData"
            },
            "Info":{
               "e":[
                  {
                     "n":"Name",
                     "u":"",
                     "sv":"LightSensor",
                     "min":0,
                     "max":0,
                     "asm":"r",
                     "type":"s",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"sw",
                     "u":"",
                     "sv":"1.0.00",
                     "min":0,
                     "max":0,
                     "asm":"r",
                     "type":"s",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  }
               ],
               "bn":"Info"
            },
            "Net":{
               "e":[
                  {
                     "n":"sw",
                     "u":"",
                     "sv":"2.0.0.0",
                     "min":0,
                     "max":0,
                     "asm":"r",
                     "type":"s",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"Neighbor",
                     "u":"",
                     "sv":"",
                     "min":0,
                     "max":0,
                     "asm":"r",
                     "type":"s",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  },
                  {
                     "n":"Health",
                     "u":"",
                     "v":100,
                     "min":0,
                     "max":0,
                     "asm":"r",
                     "type":"d",
                     "rt":"",
                     "st":"ipso",
                     "exten":""
                  }
               ],
               "bn":"Net"
            },
            "Action":{
               "e":[

               ],
               "bn":"Action"
            },
            "ver":1
         }
      },
      "commCmd":2052,
      "requestID":2001,
      "agentID":"0017000004016943",
      "handlerName":"general",
      "sendTS":160081024
   }
}

Data Upload Format in JSON:

{
   "susiCommData":{
      "data":{
         "SenHub":{
            "SenData":{
               "e":[
                  {
                     "n":"Header",
                     "v":47
                  },
                  {
                     "n":"ExtendedTelegramType",
                     "v":7
                  },
                  {
                     "n":"OriginatorID",
                     "sv":"000004016943"
                  },
                  {
                     "n":"FwVersion",
                     "v":1
                  },
                  {
                     "n":"PacketType",
                     "v":0
                  },
                  {
                     "n":"ActionMode",
                     "v":0
                  },
                  {
                     "n":"PacketIndex",
                     "v":195
                  },
                  {
                     "n":"TxType",
                     "v":1
                  },
                  {
                     "n":"BatteryVoltage",
                     "v":15
                  },
                  {
                     "n":"Light1",
                     "v":0
                  },
                  {
                     "n":"Light2",
                     "v":0
                  },
                  {
                     "n":"Light3",
                     "v":0
                  },
                  {
                     "n":"Light4",
                     "v":0
                  },
                  {
                     "n":"SignalStrength",
                     "v":54
                  }
               ],
               "bn":"SenData"
            },
            "ver":1
         }
      },
      "commCmd":2055,
      "requestID":2001,
      "agentID":"0017000004016943",
      "handlerName":"general",
      "sendTS":160081115
   }
}

Protocol Specification:

http://ess-wiki.advantech.com.tw/wiki/images/d/d9/Advantech_EnOcean_light_tower_2018.03.18.pdf


How to

Software Requirements

  • USB receiver driver
  • MQTT broker
  • WISE-Agent
  • API-GW

Software Installation for Windows 10

Install Steps

  1. Install USB receiver driver
  2. Install MQTT Broker
  3. Install API-GW
  4. Install EoLinkManager , edit config, then restart service.
  5. Install WISE-Agent

Uninstall Steps

  • Select the Start button, then select Settings > Apps. Choose the program you want to remove, and then select Uninstall.
  1. WISE-Agent
  2. EoLinkManager
  3. API-GW
  4. MQTT Broker

Configuration

In Windows 10

  • You can edit C:\Program Files (x86)\Advantech\EoLinkManager\EoLinkManager.ini to change setting.
  • Notice: Once config is changed, please using Windows Services Manager to restart EoLinkManager service or reboot gateway in order to apply new setting.

Setting File example:

[Platform]
InterfaceName=EoLinkReceiver
ServerURL=127.0.0.1
ServerPort=1883
ModuleName=EoLinkManager
SensorName=LightSensor
SerialPort=COM3
Interval=1
#Interval: The time delay between data access round in second. 

[Sensors]
NumberOfSensors=2
Sensor0=04016943
Sensor1=0400E889

InterfaceName

  • Assign Interface name

ServerURL

  • Assign MQTT broker ip

ServerPort

  • Assign MQTT broker port

ModuleName

  • Assign module name

SerialPort

  • Assign serial port which USB receiver (USB300) is using.

Interval

  • The time delay between data access round in second.

NumberOfSensors

  • Assign number of Tower Light Sensor module

Sensor0

  • Assign id for Tower Light Sensor module. Format is Sensor0=<<MODULE_ID>>
  • If you have multi Tower Light Sensor module, please start at a number 0 for the first module.
  • Second module use Sensor1.

Service control

In Windows

Check if ​EoLinkManager service is running:

  • Use Service to check status of ​EoLinkManager service

Restart ​EoLinkManager service:

  • Use Service to restart EoLinkManager service

Start ​EoLinkManager service:

  • Use Service start ​EoLinkManager service

Stop ​EoLinkManager service:

  • Use Service stop ​EoLinkManager service


Grafana Dashboard

1. Sign in WISE-PaaS Dashboard using your User ID and Password:

Tower Light 03-1.png

2. Create Data Sources

Choose Configuration -> Data Source -> RMM-SimpleJson

RTENOTITLE

Edit settings as follow

RTENOTITLE

Name: RMM-SimpleJson

HTTP
URL: http://168.63.200.38/rmm/v1/grafana/simplejson/
* Notice: you need to change url for your environment.
Access: Server (default)

Auth
Basic Auth : V

Basic Auth Details
User: xxx
Password:  xxx
* Notice: you need to assign user and password for your EdgeSense authentication.

3. Create Dashboard

Choose Create -> Import -> Or paste JSON

Paste content of Tower Light dashboard Grafana Dashboard json, then choose Load.

RTENOTITLE

In RMM-EIOT , choose RMM-SimpleJSON , then choose Import to save and apply.

RTENOTITLE


4. Drop down “Home” and select Tower Light Board.

Tower Light 04-1.png

Tower Light 05-1.png


7. Drop down “Tower Light” and select “Edit” to edit the widget’s HTML:


Tower Light 06-2.png


8. Define Tower Light Sensor ID in the widget’s HTML:

Tower Light 10.png

9. Define RMM SimpleJSON url in the widget’s HTML

  • Notice: you need to change url for your environment.
    * url format is [http:// http://]<EDGESENSE_URL>/rmm/v1/grafana/simplejson/query  ,  replace <EDGESENSE_URL> with your EdgeSense url.

RTENOTITLE

5. You will see the board is showed like this when all lights off:

Tower Light 01 .png


6. You will see the board is showed like this when all lights on:

Tower Light 02 .png

Release

Index Version Date
Platform
OS
Release Note
Download Link
1 1.0.2 2018// x86_64 CPU
Windows 10

EoLinkManager 1.0.2

MQTTBrokerSetup 1.0.3

USB receiver driver:
CDM21228_Setup.exe

Grafana dashboard:
Advantech EIoT DTOS Tower Light Monitoring-Graph-04016943-ADF-20180430.json

Above files are available at local server, please paste file's url in File Explorer to copy file.

2 1.0.3 coming soon x86_64 CPU
Windows 10
  • Run as Windows service
  • Verified by WISE-PaaS/EdgeSense 1.0.98 + WISE-Agent 1.2.4
  • Support Grafana 5.4.3

API-GW 2.0.7

EoLinkManager 1.0.3

MQTTBrokerSetup 1.0.3

USB receiver driver:
CDM21228_Setup.exe

Grafana dashboard:
Advantech EIoT DTOS Tower Light Monitoring-Graph-04016943-ADF-20190503.json

Above files are available at local server, please paste file's url in File Explorer to copy file.


3


4