HMS Ewon Flexy Direct Connect Installation Tutorial¶
The Ewon Flexy Direct Connect tutorial was created as a guide to help you through the process of configuring your Exosite Business, installing the Direct Connect Application onto you hardware, and begin streaming device data directly to Exosite. This approach will bypass the Ewon Talk2M cloud.
- Exosite Business Account
- Deployed Exosense Instance
- Access to the Ewon Flexy via eCatcher
- Optional: The Ewon Flexy Direct Connect is a simple application which enables a user to quickly stream data to ExoSense. If you are interested in further development of the code base, you can download a zipped file containing the repository here.
Configure Your Exosite Business¶
Deploy Ewon Flexy Direct Connector Template¶
Click on IoT Marketplace and select IoT Connectors.
In the SEARCH field, type "ewon". This should bring up a few options under the "IoT Connectors - Build Your Own" section. Make sure to select Ewon Flexy Direct Connector Template.
Select CREATE IOT CONNECTOR and choose a name for your new connector.
Select Enable Solution to create the Connector.
Link Your IoT Connector with ExoSense¶
Navigate back to your HOME tab and find your ExoSense Instance under the Applications section.
Click on IoT Connectors on the left menu.
Click the Add IoT Connector button on the right side.
In the SEARCH field, enter the name of your new IoT Connector you created in the previous section. Click on the Exchange Element under "IoT Connectors - Off The Shelf".
Click the ADD TO SOLUTION button to bring up the list of your ExoSense Applications. Select the ExoSense Application that will be linked with the Connector.
Click on the orange ADD TO SOLUTION button to complete the link.
Your Exosite Business is now set up to handle incoming data from the Flexy. The next section will guide you through the process of installing the Exosite Direct Connect Application, as well as getting your Ewon Flexy configured to communicate with the Exosite platform.
Ewon Flexy Configuration¶
Download and Configure Application Files¶
The Ewon Direct Connect Application requires 4 files in order to run. You can download a .zip folder containing these files here:
Zip File Contents
ewonclass.jar and ewondirect.jar: JAVA Application files.
jvmrun: Responsible for starting the application when the Flexy boots up.
config.txt: Configuration file which informs the Flexy of the following parameters:
- Exosite IoT Connector Device Endpoint
- Device Polling rate
You will need to make 2 edits to config.txt. The config file allows you to manually specify your IoT Connector Host URL and the desired polling rate. Open the file and you should see the following:
[device] url = <EXOSITE SOLUTION ID>.m2.exosite.io polling_rate = 300
The Exosite Solution ID can be found within your IoT Connector. Navigate to your Exosite Business HOME page and find your new IoT Connector listed under the IoT Connectors section.
Click on your IoT Connector. Find the Copy Solution ID button located near the top left of the screen and click on it. This will copy the Solution ID to your clipboard.
Now that you have your Solution ID, return to the config.txt file. Paste the Solution ID over EXOSITE SOLUTION ID, and change the polling rate if desired. An example file after the Solution ID has been pasted will look like this:
[device] url = a4pequ1xai4sk70000.m2.exosite.io polling_rate = 120
It is recommended that you start with a polling rate no faster than 120 seconds, especially if you are logging a large number of tags.
The following steps are required to install the Direct Connect Application onto your Flexy:
Connect to the eWON Flexy via the eCatcher Application.
Establish an FTP connection to the Flexy.
- FileZilla is one of many available free applications you can use to connect via FTP.
- The Host field should be the IP Address of the Flexy. You can find this by looking at your eCatcher after connecting to the Flexy. The IP Address will be located near the top left of the eCatcher interface.
- Username/Password are the same credentials used to login to the Ewon Flexy itself.
Copy all 4 files into the Flexy's /.usr/ directory.
Flexy Tag Configuration¶
The Direct Connect application takes advantage of the Flexy’s built in Grouping feature. If desired, the user is able to configure tags to report at a consistent rate or to report only on change. To configure your tags on the Flexy, complete the following steps:
Tags that will be reporting at a regular interval (e.g. report every 2 minutes) should be subscribed to Group A or Group B.
Tags that are reporting only on change should be subscribed to Group C or Group D.
Assigning Tags to Groups
To assign a tag to a group, navigate to Tags >> Values, verify you are in SETUP mode and double-click the tag. Scroll to the very bottom of the Tag configuration page and check the box next to the group you wish to assign the tag to.
Enable Historical Logging¶
Tags that are subscribed to Group C or Group D must also have Historical logging enabled. To enable historical logging on a tag:
Connect to the Ewon Flexy via the eCatcher Application.
Make sure you are on SETUP mode and double click on the tag you wish to assign.
Scroll down to the Historical Logging section and make sure to check the box next to Historical Logging Enabled.
Set Logging Deadband to a non-negative number (We recommend setting it to 0). The Tag value will only be reported if the value changes ± the Logging Deadband.
In order to ensure that tags with Historical Logging enabled are reported in real time, the Flexy's timezone needs to be set to UTC.
Navigate to Setup >> Main >> Date & Time.
In the Timezone drop down menu, find and select Etc/GMT (UTC).
Check the box next to "Record data in UTC".
Now that you have you Ewon Flexy fully configured, you can begin the process of streaming data to your ExoSense Instance! Go ahead and reboot your Flexy to initiate the Direct Connect Application, and data will begin to report within a matter of minutes! The next section will guide you through the process of building the config_io for your device.
ExoSense Configuration File¶
The final step is to create a config_io. You can learn more about this by taking a look at our Channel Configuration Documentation. The config_io will need to contain configuration information for each Flexy tag your wish to report. We recommend starting with a config_io consisting of only a single tag defined until a consistent data connection is established. Once you have data flowing, you can build the rest of the config_io.
Tag_Data_Type: Data type of the Tag. This needs to follow the Exosense data schema. To find the list of supported data types, check out our Exosense Data Type Documentation.
Tag_Data_Unit: Data unit of the Tag. This needs to follow the Exosense data schema. To find the list of supported Data units, check out our Exosense Data Type Documentation.
Tag_Description: User-defined description of the Tag which will be exposed at the Signal level in Exosense.
Tag_Display_Name: User-defined display name of the Tag which will be exposed in Exosense Dashboards.
Tag_Number: Tag ID number as defined on the eWON Flexy.
Identify Tag Number
If you do not already know the Tag Number, go to Diagnostic >> Files Transfer and download the var_lst.csv file. You can open this in Excel by changing the separator to the (semi-colon) symbol, or use a text editor to replace any (semi-colon) symbols with (comma). The tag number is the first column in the spreadsheet.
Create a New Data Channel in ExoSense¶
Once you have the required information for your tag/s, you are ready to build the config_io.
Login to your ExoSense Instance and assign your new device to a group. Instructions on how to assign a device to a group can be found in our Exoense Building Connected Devices documentation.
Navigate to Device Management on the left-side menu. Make sure you are under the DEVICES tab and click on your device.
Click on the CHANNELS tab near the top of the screen to bring up the list of configured channels.
Click the (+) button.
Using the tag parameters defined in the previous section, define the fields in the Add Channel Definition window as follows:
E: Tag_Number NOTE: You will need to change the Protocol to "Custom", and define the Application as "Ewon".
Click the ADD button.
Make sure to click the SAVE button located on the top right of the screen. This will sync the config_io with your device and allow you to start displaying the configured signals on your Dashboard.
Your Flexy should now be reporting data to Exosite! The next step will be to create an Asset and start building out your Dashboards using the previously configured data channels. To continue building your Asset, follow the Create an Asset ExoSense documentation to begin the next steps.
For support, email firstname.lastname@example.org