... | @@ -13,7 +13,7 @@ So this Service is fowarding incoming EnOcean messages to the MessagingService i |
... | @@ -13,7 +13,7 @@ So this Service is fowarding incoming EnOcean messages to the MessagingService i |
|
## Interface
|
|
## Interface
|
|
|
|
|
|
### Incoming EnOcean Messages (from a EnOcean device)
|
|
### Incoming EnOcean Messages (from a EnOcean device)
|
|
The EnOcean Service receives messages from EnOcean devices. It accepts only devices that are registered in the Address Management (see [Device and Address Management](#device)). The Service also handles also Teach-In and Teach-Out messages.
|
|
The EnOcean Service receives messages from EnOcean devices. It accepts only devices that are registered in the Address Management (see [Device and Address Management](#device-and-address-management)). The Service also handles also Teach-In and Teach-Out messages.
|
|
If a device has an entry in the Address Management the Service mapps the data to Fredosar DTO's(Data Transfer Objects) and publishes the messages to the [MessagingService](https://ressel.fh-salzburg.ac.at/FREDOSAR/Framework/wikis/tutorial-core-service-messaging).
|
|
If a device has an entry in the Address Management the Service mapps the data to Fredosar DTO's(Data Transfer Objects) and publishes the messages to the [MessagingService](https://ressel.fh-salzburg.ac.at/FREDOSAR/Framework/wikis/tutorial-core-service-messaging).
|
|
The **topic** of the messages are:`in.homeatomation.enocean.[FredosarDevice].[FredosarID]`
|
|
The **topic** of the messages are:`in.homeatomation.enocean.[FredosarDevice].[FredosarID]`
|
|
* FredosarDevice: is the type of the device and is a constant from org.fredosar.core.types
|
|
* FredosarDevice: is the type of the device and is a constant from org.fredosar.core.types
|
... | @@ -21,8 +21,8 @@ The **topic** of the messages are:`in.homeatomation.enocean.[FredosarDevice].[Fr |
... | @@ -21,8 +21,8 @@ The **topic** of the messages are:`in.homeatomation.enocean.[FredosarDevice].[Fr |
|
|
|
|
|
The Message is a `List<FredosarType>` that is mapped to a JSON String.
|
|
The Message is a `List<FredosarType>` that is mapped to a JSON String.
|
|
|
|
|
|
For more information see [Device and Address Management](#device).
|
|
For more information see [Device and Address Management](#evice-and-address-management).
|
|
Not all devices send data. Some are only receiving commands for details of the devices see [Implemented Devices/Packets](#implDev).
|
|
Not all devices send data. Some are only receiving commands for details of the devices see [Implemented Devices/Packets](#implemented-devicespackets).
|
|
|
|
|
|
|
|
|
|
### Outgoing EnOcean Messages (to a EnOcean device)
|
|
### Outgoing EnOcean Messages (to a EnOcean device)
|
... | @@ -33,7 +33,7 @@ The EnOcean Service can send messages/controls to EnOcean devices (only if the d |
... | @@ -33,7 +33,7 @@ The EnOcean Service can send messages/controls to EnOcean devices (only if the d |
|
If the device supports receiving commands the EnOcean Service will send the command to the device (see [Implemented Devices/Packets](#implDev) for supported devices).
|
|
If the device supports receiving commands the EnOcean Service will send the command to the device (see [Implemented Devices/Packets](#implDev) for supported devices).
|
|
The EnOcean service can receive `List<FredosarType>` or `FredosarType` to control devices. If a list of FredosarType is sent the Service will send the commands in the order they are in the list.
|
|
The EnOcean service can receive `List<FredosarType>` or `FredosarType` to control devices. If a list of FredosarType is sent the Service will send the commands in the order they are in the list.
|
|
|
|
|
|
<a name="device"></a>
|
|
|
|
## Device and Address Management
|
|
## Device and Address Management
|
|
Every EnOcean device has to have an entry in the Address Management of FREDOSAR. Access the Address Management via the Web Interface of FREDOSAR.
|
|
Every EnOcean device has to have an entry in the Address Management of FREDOSAR. Access the Address Management via the Web Interface of FREDOSAR.
|
|
|
|
|
... | @@ -42,7 +42,7 @@ A entry for a device has: |
... | @@ -42,7 +42,7 @@ A entry for a device has: |
|
* Technology: For the EnOcean Service `org.fredosar.service.io.enocean`
|
|
* Technology: For the EnOcean Service `org.fredosar.service.io.enocean`
|
|
* Receiver Information: Consists out of 2 information's. The EnOcean device ID and the EEP packet description. The syntax is `0x[EnOcean ID in hex].[EEP]`:
|
|
* Receiver Information: Consists out of 2 information's. The EnOcean device ID and the EEP packet description. The syntax is `0x[EnOcean ID in hex].[EEP]`:
|
|
* EnOcean ID: Is the unique ID of the EnOcean device. The EnOcean ID is displayed in the terminal when the device sends a message and is not in the Address Management.
|
|
* EnOcean ID: Is the unique ID of the EnOcean device. The EnOcean ID is displayed in the terminal when the device sends a message and is not in the Address Management.
|
|
* EEP: Describes the data packet that is sent of the device. This information can be found in the manual of the device (EnOcean Equipment Profile (EEP)). All in FREDOSAR implemented data packets are listed in [Implemented Devices/Packets](#implDev)
|
|
* EEP: Describes the data packet that is sent of the device. This information can be found in the manual of the device (EnOcean Equipment Profile (EEP)). All in FREDOSAR implemented data packets are listed in [Implemented Devices/Packets](#implemented-devicespackets)
|
|
|
|
|
|
Here is an example for an entry in the Address Management:
|
|
Here is an example for an entry in the Address Management:
|
|
|
|
|
... | @@ -54,7 +54,7 @@ Here is an example where you can see the EnOcean ID of an device in the console: |
... | @@ -54,7 +54,7 @@ Here is an example where you can see the EnOcean ID of an device in the console: |
|
|
|
|
|
If the device has a Teach-In function the EEP entry is not necessary. The teach in adds the Packed description automatically when a Teach-In is done.
|
|
If the device has a Teach-In function the EEP entry is not necessary. The teach in adds the Packed description automatically when a Teach-In is done.
|
|
|
|
|
|
<a name="implDev"></a>
|
|
|
|
## Implemented Devices/Packets
|
|
## Implemented Devices/Packets
|
|
|
|
|
|
Here is a List of implemented EEP packets and devices
|
|
Here is a List of implemented EEP packets and devices
|
... | | ... | |