Subscribe to Our Youtube Channel
Related Manuals for Franklin Electric EVO200
Summary of Contents for Franklin Electric EVO200
- Page 1 FUELING SYSTEMS MQTT WITH EVO™ SERIES CONSOLES P R O G R A M M I N G G U I D E FETD-0002 r1 MONITORING CONSOLE EVO200 EVO400 EVO600 EVO6000 EVO-LLDS...
- Page 2 Copyright © 2024 Franklin Electric Co., Inc., Madison, WI 53718. All world rights reserved. No part of this publication may be stored in a retrieval system, transmitted, or reproduced in any way, including, but not limited to, photocopy, photograph, magnetic, or other record, without the prior written permission of Franklin Electric.
-
Page 3: Table Of Contents
Contents 1 Introduction ........................1 1.1 Documentation ......................1 1.2 Documentation ......................1 1.2.1 Symbol Legend ....................1 2 Safety/Security ........................2 2.1 General Safety Information..................2 2.2 Installation & Service Access ..................2 2.3 Documentation Availability ..................2 2.4 Hazard Assessment ....................3 2.5 Required Personal Protective Equipment (PPEs) ............3 2.6 Cyber Security ......................3 2.7 Qualifications and Responsibilities ................4 2.7.1 Qualifications for Programming ...............4... - Page 4 3.4.1.2 Converting D-Bus Information to MQTT Command Format ....18 3.4.2 Understanding XPaths and XML Strings ............19 3.4.2.1 Locating XML Configuration Information ........19 3.4.2.2 Converting XML Information to XPaths ..........20 3.4.2.3 Converting XML Information to XML Strings ........20 3.5 Testing MQTT with EVO™ using MQTTX ..............21 3.5.1 Initial MQTTX Setup ..................21 3.5.2 Testing Commands ..................23 3.5.2.1 Using the readDbus Command ............23...
-
Page 5: Introduction
• It is the installer’s responsibility to ensure that correct and safe procedures are followed at the worksite. • This document and related documents are available from Franklin Electric at www.franklinfueling.com. 1.2.1 Symbol Legend Wear Protective Headwear... -
Page 6: Safety/Security
The station owner or operator of the console is only allowed to access the user interface. Access to areas internal to the console is prohibited. *If your console is serviced by someone who is not a Franklin Electric certified installer, service (technician), or programmer, your warranty will be void. -
Page 7: Hazard Assessment
firmware version available to ensure device security features are up to date. The manufacturer, Franklin Electric and its affiliates are not liable for damages and / or losses related to such security breaches, any unauthorized access, interference,... -
Page 8: Qualifications And Responsibilities
(see § 2.7.1), follow all local laws, rules and regulations, along with the instructions and the specifications listed in this document. • The certified programmer(s) to know the EVO™ consoles and its safe installation. • The certified programmer(s) to have and maintain a valid Franklin Electric FMS Programming Certification. -
Page 9: Programming
Programming Requirements An Established MQTT Broker • Address/port • Connection protocol type • Any credential requirements An EVO™ With Complete TCP Network • May require NTP Servers to be configured. • Can be Ethernet or wireless. • If using a named network address for the broker and Ethernet connection, ensure the Gateway and DNS Servers are configured properly. -
Page 10: Configuration
Configuration Set each parameter in the following sections accordingly per the site. Group Parameter Name Parameter Value … Communications … Protocols … MQTT … Connection # Name » Enter the desired name of the MQTT connection. Service Custom Access Level » Select the access level of the connection. »... -
Page 11: Commands
Group Parameter Name Parameter Value Connection Retry » Select the time the system will delay after Interval reaching the connection retries limit before it attempts connection again. » 10 seconds » 30 seconds » 1 minute » 30 minutes » 1 hour »... -
Page 12: Readactiveevents
3.3.1.2 readActiveEvents Purpose – Causes the device to publish active events and requested events on its evt/readActiveEvents topic. Access Level – Guest Payload Format – “priority”: “<Device Event Priority>” , “extraData”: <Device Event Extra Data Flag> , “eventIds”: [“<Event ID>”, …] , “requestId”: “<Request ID>”... -
Page 13: Readreleaseinfo
3.3.1.4 readReleaseInfo Purpose – Causes the device to publish requested sections of the current configuration on its evt/readReleaseInfo topic. Access Level – Guest Payload Format – “requestId”: “<Request ID>” , “id”: <Device ID Flag> , “platform”: <Device Platform Flag> , “generation”: <Device Generation Flag> , “name”: <Device Name Flag>... -
Page 14: Subscribe Commands
3.3.2 Subscribe Commands Subscribe commands request the EVO™ to continually monitor specified information and update upon any relevant changes until the subscription or connection is ended. 3.3.2.1 subscribeDbus Purpose – Causes the EVO™ to publish specific updates to the evt/dbus topic. Access Level –... -
Page 15: Subscribeevents
3.3.2.2 subscribeEvents Purpose – Causes the EVO™ to publish specific event notifications to the evt/event topic. Access Level – Administrator Payload Format – “priority”: “<Device Event Priority>” , “extraData”: <Device Event Extra Data Flag> Response Format – “events”: [ “id”: “<64-bit signed integer>” , “code”: “<Internal device event code name>”... -
Page 16: Control Commands
3.3.3 Control Commands 3.3.3.1 changeConfiguration Purpose – Causes the device to perform a configuration merge, or possibly a series of merges, with the current configuration. Access Level – Administrator Payload Format – { “changes” : [“<XML String>”, … ] } Notes –... -
Page 17: Generate Report Commands
scheduled time, first cancel the scheduled ratio change by sending a command with “schedule” set to none, then send another command with the appropriate schedule. • If not present, ratios will be set immediately. • If set to none, the scheduled ratio change will be cancelled. 3.3.4 Generate Report Commands 3.3.4.1... - Page 18 • For “device” payload fields, options are (choose one): “tank <tank number>” “manifold <manifold number>” “all” • For “tests” payload fields, the options are (may choose multiple): {“gross”: true} {“monthly”: true} {“annual”: true} NOTE: As an example, for tgLineLeakReport, the following payload may be used: {“dateRange”: “last 30 days”, “tests”: {“gross”: true, “monthly”: true}} •...
-
Page 19: Payload Information References
Payload Information References 3.4.1 Understanding D-Bus The D-Bus interface contains information stored and updated live by the EVO™. Any information available in the D-Bus interface may be published through MQTT commands. To access the D-Bus interface, from the Web Browser Interface, navigate to https://<EVO™... -
Page 20: Locating D-Bus Information
3.4.1.1 Locating D-Bus Information To publish or subscribe to information, it is required to locate the correct Object Path, Interface, D-Bus Name, and Property Name of the desired information. For example, if the desired information is the product level of a tank, the location of that information can be found by navigating to –... - Page 21 4. /TG/Fms/Storage 5. /TG/Fms/Storage/Tank 6. /TG/Fms/Storage/Tank/1 With the final landing page displaying the tank product level property name –...
-
Page 22: Converting D-Bus Information To Mqtt Command Format
3.4.1.2 Converting D-Bus Information to MQTT Command Format To publish or subscribe to information, it is required to input the correct information into the MQTT Command Format. For example, to convert the tank product level information located in the previous section of this guide, follow the image and format below. -
Page 23: Understanding Xpaths And Xml Strings
3.4.2 Understanding XPaths and XML Strings 3.4.2.1 Locating XML Configuration Information To view the XML for the current configuration, from the Web Browser Interface, navigate to Settings > Configuration and select Download. Then, open the file with a browser to view an XML document that looks like this –... -
Page 24: Converting Xml Information To Xpaths
3.4.2.2 Converting XML Information to XPaths XPaths are used to identify nodes or node-sets in XML documents. The following examples use the XML below. • To view all of FMS information, the path would be: CONFIGURATION/FMS • To view only PRODUCTS information, the path would be: CONFIGURATION/FMS/PRODUCTS •... -
Page 25: Testing Mqtt With Evo™ Using Mqttx
Testing MQTT with EVO™ using MQTTX To test MQTT protocol with EVO™, a user may use MQTTX, a free public broker. 3.5.1 Initial MQTTX Setup 1. Download the applicable desktop version of MQTTX ( ). 2. Open MQTTX and select + New Connection ( ). - Page 26 3. Enter a Name ( ) for the connection and press Connect ( ). All other entries may remain at default. 4. Ensure the EVO™ settings are setup to properly connect with the broker ( ). Group Parameter Name Parameter Value …...
-
Page 27: Testing Commands
3.5.2 Testing Commands NOTE: All commands in the following examples use the following format: iot-2/type/tg/id/<Device ID>/<evt/cmd>/<command>/fmt/<format(i.e. json)> topic 3.5.2.1 Using the readDbus Command 1. Select + New Subscription ( ). 2. Enter iot-2/type/tg/id/<Device ID>/evt/readDbus/fmt/json for the Topic ( ) and select Confirm ( ). - Page 28 3. Enter iot-2/type/tg/id/<Device ID>/cmd/readDbus/fmt/json in the Topic entry box ( ) and the desired payload in the Payload entry box ( ), then press the send icon ( ). NOTE: Payload entries are case sensitive. 4. The response will immediately populate in messages ( ).
-
Page 29: Using The Readactiveevents Command
3.5.2.2 Using the readActiveEvents Command 1. Select + New Subscription ( ). 2. Enter iot-2/type/tg/id/<Device ID>/evt/readActiveEvents/fmt/json for the Topic ( ) and select Confirm ( ). - Page 30 3. Enter iot-2/type/tg/id/<Device ID>/cmd/readActiveEvents/fmt/json in the Topic entry box ( ) and the desired payload in the Payload entry box ( ), then press the send icon ( ). 4. The response will immediately populate in messages ( ).
-
Page 31: Using The Readconfiguration Command
3.5.2.3 Using the readConfiguration Command 1. Select + New Subscription ( ). 2. Enter iot-2/type/tg/id/<Device ID>/evt/readConfiguration/fmt/json for the Topic ( ) and select Confirm ( ). - Page 32 3. Enter iot-2/type/tg/id/<Device ID>/cmd/readConfiguration/fmt/json in the Topic entry box ( ) and the desired payload in the Payload entry box ( ), then press the send icon ( ). 4. The response will immediately populate in messages ( ).
-
Page 33: Using The Readreleaseinfo Command
3.5.2.4 Using the readReleaseInfo Command 1. Select + New Subscription ( ). 2. Enter iot-2/type/tg/id/<Device ID>/evt/readReleaseInfo/fmt/json for the Topic ( ) and select Confirm ( ). - Page 34 3. Enter iot-2/type/tg/id/<Device ID>/cmd/readReleaseInfo/fmt/json in the Topic entry box ( ) and the desired payload in the Payload entry box ( ), then press the send icon ( ). 4. The response will immediately populate in messages ( ).
-
Page 35: Using The Subscribedbus Command
3.5.2.5 Using the subscribeDbus Command 1. Select + New Subscription ( ). 2. Enter iot-2/type/tg/id/<Device ID>/evt/dbus/fmt/json for the Topic ( ) and select Confirm ( ). - Page 36 3. Enter iot-2/type/tg/id/<Device ID>/cmd/subscribeDbus/fmt/json in the Topic entry box ( ) and the desired payload in the Payload entry box ( ), then press the send icon ( ). 4. The response will immediately populate in messages ( ).
-
Page 37: Using The Subscribeevents Command
3.5.2.6 Using the subscribeEvents Command 1. Select + New Subscription ( ). 2. Enter iot-2/type/tg/id/<Device ID>/evt/event/fmt/json for the Topic ( ) and select Confirm ( ). 3. Enter iot-2/type/tg/id/<Device ID>/cmd/subscribeEvents/fmt/json in the Topic entry box ( ) and the desired payload in the Payload entry box ( ), then press the send icon ( ). -
Page 38: Using The Changeconfiguration Command
4. Whenever an event that falls within the specifications occur, a response will immediately populate in messages ( ). 3.5.2.7 Using the changeConfiguration Command 1. Enter iot-2/type/tg/id/<Device ID>/cmd/changeConfiguration/fmt/json in the Topic entry box ( ) and the desired payload in the Payload entry box ( ), then press the send icon ( ). -
Page 39: Using The Tgalarmhistory Report Command
3.5.2.8 Using the tgAlarmHistory Report Command 1. Select + New Subscription ( ). 2. Enter iot-2/type/tg/id/<Device ID>/evt/tgAlarmHistoryReport/fmt/json for the Topic ( ) and select Confirm ( ). - Page 40 3. Enter iot-2/type/tg/id/<Device ID>/cmd/tgAlarmHistoryReport/fmt/json in the Topic entry box ( ) and the desired payload in the Payload entry box ( ), then press the send icon ( ). 4. The response will immediately populate in messages ( ).
-
Page 41: Appendix
Appendix Related Documents Documentation can be found online at www.franklinfueling.com. Part Number Description 228180003 EVO™ 200 and 400 Series Console Install Guide 228180015 EVO™ 200 and 400 Series Console Programming Guide 228180033 EVO™ 600 and 6000 Series Console Install Guide 228180061 EVO™... -
Page 42: Notes
Notes... - Page 44 FUELING SYSTEMS FETD-0002 r1 December 19, 2024...
Need help?
Do you have a question about the EVO200 and is the answer not in the manual?
Questions and answers