Initial commit

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -0,0 +1,99 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

README.md

@@ -0,0 +1 @@
+# Promag400Modbus

html-templates/Alerts.html

@@ -0,0 +1 @@
+<module>Alerts</module>

html-templates/Device.html

@@ -0,0 +1,42 @@
+<div class="row row-flex box-me">
+    <div class="col-md-6 text-center">
+        <h2 class="uppercase">Public IP Address</h2>
+        <p><%= channels["promagmbs.public_ip_address"].value %><p>
+    </div>
+</div>
+
+<style>
+    .uppercase {
+        text-transform: uppercase;
+        font-size: 14px;
+        color: #666;
+        font-weight: 400;
+        letter-spacing: 1px;
+        z-index: 100;
+    }
+
+    .box-me {
+        position: relative;
+        padding: 0.5em;
+        padding-bottom: 1.5em;
+        border: 1px solid #eee;
+        /*margin: 1em 0;*/
+    }
+    .row-flex {
+        display: -webkit-box;
+        display: -webkit-flex;
+        display: -ms-flexbox;
+        display: flex;
+        flex-wrap: wrap;
+    }
+
+    .row-flex > [class*='col-'] {
+        display: flex;
+        flex-direction: column;
+    }
+
+    p {
+        font-size: 1.25em;
+    }
+
+</style>

html-templates/NodeDetailHeader.html

@@ -0,0 +1,6 @@
+<div class='col-xs-1'>
+    <div class="<%= nodecolors.statuscolor %> nodecolor"></div>
+</div>
+<div class='col-xs-6'>
+    <h3><%= node.vanityname %></h3>
+</div>

html-templates/Nodelist.html

@@ -0,0 +1,31 @@
+<style>
+    .header h4 {
+        position: relative;
+        top: 0.9em;
+    }
+    .header h2 {
+        text-transform: uppercase;
+        font-size: 14px;
+        color: #aaa;
+        margin: 0.75em 0;
+    }
+    .header p {
+        font-size: 24px;
+        color: black;
+        font-weight: 600;
+    }
+</style>
+
+<div class="row header">
+    <div class="col-xs-1">
+        <div class="<%= nodecolors.statuscolor %> nodecolor"></div>
+    </div>
+
+    <div class="col-xs-2">
+        <img src="<%= nodeimgurl %>" />
+    </div>
+
+    <div class="col-xs-4">
+        <h4><%= node.vanityname %></h4>
+    </div>
+</div>

html-templates/Overview.html

@@ -0,0 +1,121 @@
+
+<div class="row row-flex box-me">
+    <div class="col-xs-12 text-center">
+        <h1>HEADER 1</h1>
+    </div>
+    <div class="col-xs-4 text-center">
+        <h2>CHANNEL 1</h2>
+        <div class="gauge-box">
+            <div data-labelheight="10"
+            style="height: 170px; background: transparent; margin: 0 auto;"
+            id="gauge-channel_1"
+            data-chart="solidgauge"
+            data-nodename="promagmbs.channel_1"
+            data-units="UNITS"
+            data-min="0"
+            data-max="100"
+            data-decimalplaces="2"
+            data-colors="0.1:#DF5353,0.5:#DDDF0D,0.9:#55BF3B"
+            data-valuefontsize="18px">
+            </div>
+            <div class- "timestamp-box">
+                <a href="#" data-channelId="<%= channels['promagmbs.channel_1'].channelId %>" class="data-table" title="Download Channel History">
+                    <i class="fa fa-download"></i>
+                </a>
+            </div>
+            <span data-timeupdate="channel_1">
+                <%= channels["promagmbs.channel_1"].timestamp %>
+            </span>
+        </div>
+    </div>
+</div>
+
+
+
+
+
+<style>
+
+.box-me {
+    position: relative;
+    padding: 0.5em;
+    padding-bottom: 1.5em;
+    border: 1px solid #eee;
+    /*margin: 1em 0;*/
+}
+
+.box-me .gauge-box {
+    margin-top: -0.25em;
+}
+
+.pad15 {
+    margin: 15px 15px;
+}
+
+.box-me h2 {
+    text-transform: uppercase;
+    font-size: 14px;
+    color: #666;
+    font-weight: 400;
+    letter-spacing: 1px;
+    z-index: 100;
+}
+
+.dynamic-chart-form {
+    background-color: whiteSmoke;
+    padding: 1em 0.5em;
+    margin-top: 1em;
+}
+
+.row-flex {
+    display: -webkit-box;
+    display: -webkit-flex;
+    display: -ms-flexbox;
+    display: flex;
+    flex-wrap: wrap;
+}
+
+.row-flex > [class*='col-'] {
+    display: flex;
+    flex-direction: column;
+}
+
+#systemStatusTimelineContainer h2 {
+    text-transform: uppercase;
+    font-size: 14px;
+    color: #666;
+    font-weight: 400;
+    letter-spacing: 1px;
+    z-index: 100;
+}
+
+.slice.node-detail hr {
+    border-color: #ccc;
+}
+.slice.node-detail #alarms li {
+    margin-bottom: 1em;
+    padding: 0.5em;
+}
+.slice.node-detail #alarms li:nth-child(even){
+    background-color: whiteSmoke;
+}
+.slice.node-detail #alarms li span {
+    margin-left: 1em;
+    color: #aaa;
+}
+</style>
+
+<script>
+
+$('.val_box').each(function(topLevel){
+    $(this).change(function(){
+        var id = "#" + $(this).closest(".entry-top-level").attr('id');
+        if (id !== "#undefined"){
+            var val = $(id).find('.val_box').val();
+            var tag = $(id).find('.setstatic').attr('data-staticsend', val);
+            console.log($(id).find('.setstatic').attr('data-staticsend'));
+        }
+    });
+});
+
+</script>

html-templates/Sidebar.html

@@ -0,0 +1,15 @@
+<a href="#"
+    data-channelId="<%= channels["promagmbs.log"].channelId %>"
+    class="data-table btn-block btn btn-theme animated"
+    title="Device Log"><i style='margin-left: 0.5em; cursor: pointer' class="fa fa-th-list icon-theme"></i> Device Log</a>
+
+<a href="#"
+    data-refreshpause="1"
+    data-staticsend="1"
+    data-channelId="<%= channels["promagmbs.sync"].channelId %>"
+    data-techname="<%=channels["promagmbs.sync"].techName %>"
+    data-name="<%= channels["promagmbs.sync"].name%>"
+    data-nodechannelcurrentId="<%= channels["promagmbs.sync"].nodechannelcurrentId %>"
+    id="<%= channels["promagmbs.sync"].channelId %>"
+    class="btn btn-large btn-block btn-theme animated setstatic mqtt">
+    <i class="icon-repeat icon-white mqtt" ></i>Sync All Data</a>

html-templates/Trends.html

@@ -0,0 +1,37 @@
+<div class='col-xs-12' style="padding-top: 1em; margin-bottom: 1em;">
+    <div class="input-daterange input-group" id="datepicker">
+        <input data-chartid="dynamicChart" id="fromDate" data-daysofhistory="7"  type="text" class="form-control" name="start">
+        <span class="input-group-addon">to</span>
+        <input class="form-control" data-chartid="dynamicChart" id="toDate" type="text"  name="end">
+        <span class='input-group-btn'>
+            <a href="#!" data-chartid="dynamicChart" data-otherchartids="statusTimeline" class="btn chart-update btn-theme">Run</a>
+        </span>
+    </div>
+</div>
+<hr>
+<div class='clearfix col-xs-12'
+    style='height: 450px'
+    id="dynamicChart"
+    data-chart="dynamicchart"
+    data-daysofhistory="7"
+    data-chartlabel="Data"
+    data-ylabel=""
+    data-xlabel="Date"
+    data-units=""
+    data-channelnames="promagmbs.channel_1,">
+</div>
+<style>
+.dynamic-chart-form {
+    background-color: whiteSmoke;
+    padding: 1em 0.5em;
+    margin-top: 1em;
+}
+#systemStatusTimelineContainer h2 {
+    text-transform: uppercase;
+    font-size: 14px;
+    color: #666;
+    font-weight: 400;
+    letter-spacing: 1px;
+    z-index: 100;
+}
+</style>

python-driver/Channel.py

@@ -0,0 +1,282 @@
+"""Define Meshify channel class."""
+from pycomm.ab_comm.clx import Driver as ClxDriver
+from pycomm.cip.cip_base import CommError, DataError
+import time
+
+
+def binarray(intval):
+    """Split an integer into its bits."""
+    bin_string = '{0:08b}'.format(intval)
+    bin_arr = [i for i in bin_string]
+    bin_arr.reverse()
+    return bin_arr
+
+
+def read_tag(addr, tag):
+    """Read a tag from the PLC."""
+    c = ClxDriver()
+    try:
+        if c.open(addr):
+            try:
+                v = c.read_tag(tag)
+                return v
+            except DataError:
+                c.close()
+                print("Data Error during readTag({}, {})".format(addr, tag))
+    except CommError:
+        # err = c.get_status()
+        c.close()
+        print("Could not connect during readTag({}, {})".format(addr, tag))
+        # print err
+    except AttributeError as e:
+        c.close()
+        print("AttributeError during readTag({}, {}): \n{}".format(addr, tag, e))
+    c.close()
+    return False
+
+
+def read_array(addr, tag, start, end):
+    """Read an array from the PLC."""
+    c = ClxDriver()
+    if c.open(addr):
+        arr_vals = []
+        try:
+            for i in range(start, end):
+                tag_w_index = tag + "[{}]".format(i)
+                v = c.read_tag(tag_w_index)
+                # print('{} - {}'.format(tag_w_index, v))
+                arr_vals.append(round(v[0], 4))
+            # print(v)
+            if len(arr_vals) > 0:
+                return arr_vals
+            else:
+                print("No length for {}".format(addr))
+                return False
+        except Exception:
+            print("Error during readArray({}, {}, {}, {})".format(addr, tag, start, end))
+            err = c.get_status()
+            c.close()
+            print err
+            pass
+        c.close()
+
+
+def write_tag(addr, tag, val):
+    """Write a tag value to the PLC."""
+    c = ClxDriver()
+    if c.open(addr):
+        try:
+            cv = c.read_tag(tag)
+            wt = c.write_tag(tag, val, cv[1])
+            return wt
+        except Exception:
+            print("Error during writeTag({}, {}, {})".format(addr, tag, val))
+            err = c.get_status()
+            c.close()
+            print err
+        c.close()
+
+
+class Channel(object):
+    """Holds the configuration for a Meshify channel."""
+
+    def __init__(self, mesh_name, data_type, chg_threshold, guarantee_sec, map_=False, write_enabled=False):
+        """Initialize the channel."""
+        self.mesh_name = mesh_name
+        self.data_type = data_type
+        self.last_value = None
+        self.value = None
+        self.last_send_time = 0
+        self.chg_threshold = chg_threshold
+        self.guarantee_sec = guarantee_sec
+        self.map_ = map_
+        self.write_enabled = write_enabled
+
+    def __str__(self):
+        """Create a string for the channel."""
+        return "{}\nvalue: {},  last_send_time: {}".format(self.mesh_name, self.value, self.last_send_time)
+
+    def check(self, new_value, force_send=False):
+        """Check to see if the new_value needs to be stored."""
+        send_needed = False
+        send_reason = ""
+        if self.data_type == 'BOOL' or self.data_type == 'STRING':
+            if self.last_send_time == 0:
+                send_needed = True
+                send_reason = "no send time"
+            elif self.value is None:
+                send_needed = True
+                send_reason = "no value"
+            elif not (self.value == new_value):
+                if self.map_:
+                    if not self.value == self.map_[new_value]:
+                        send_needed = True
+                        send_reason = "value change"
+                else:
+                    send_needed = True
+                    send_reason = "value change"
+            elif (time.time() - self.last_send_time) > self.guarantee_sec:
+                send_needed = True
+                send_reason = "guarantee sec"
+            elif force_send:
+                send_needed = True
+                send_reason = "forced"
+        else:
+            if self.last_send_time == 0:
+                send_needed = True
+                send_reason = "no send time"
+            elif self.value is None:
+                send_needed = True
+                send_reason = "no value"
+            elif abs(self.value - new_value) > self.chg_threshold:
+                send_needed = True
+                send_reason = "change threshold"
+            elif (time.time() - self.last_send_time) > self.guarantee_sec:
+                send_needed = True
+                send_reason = "guarantee sec"
+            elif force_send:
+                send_needed = True
+                send_reason = "forced"
+        if send_needed:
+            self.last_value = self.value
+            if self.map_:
+                try:
+                    self.value = self.map_[new_value]
+                except KeyError:
+                    print("Cannot find a map value for {} in {} for {}".format(new_value, self.map_, self.mesh_name))
+                    self.value = new_value
+            else:
+                self.value = new_value
+            self.last_send_time = time.time()
+            print("Sending {} for {} - {}".format(self.value, self.mesh_name, send_reason))
+        return send_needed
+
+    def read(self):
+        """Read the value."""
+        pass
+
+
+def identity(sent):
+    """Return exactly what was sent to it."""
+    return sent
+
+
+class ModbusChannel(Channel):
+    """Modbus channel object."""
+
+    def __init__(self, mesh_name, register_number, data_type, chg_threshold, guarantee_sec, channel_size=1, map_=False, write_enabled=False, transformFn=identity):
+        """Initialize the channel."""
+        super(ModbusChannel, self).__init__(mesh_name, data_type, chg_threshold, guarantee_sec, map_, write_enabled)
+        self.mesh_name = mesh_name
+        self.register_number = register_number
+        self.channel_size = channel_size
+        self.data_type = data_type
+        self.last_value = None
+        self.value = None
+        self.last_send_time = 0
+        self.chg_threshold = chg_threshold
+        self.guarantee_sec = guarantee_sec
+        self.map_ = map_
+        self.write_enabled = write_enabled
+        self.transformFn = transformFn
+
+    def read(self, mbsvalue):
+        """Return the transformed read value."""
+        return self.transformFn(mbsvalue)
+
+
+class PLCChannel(Channel):
+    """PLC Channel Object."""
+
+    def __init__(self, ip, mesh_name, plc_tag, data_type, chg_threshold, guarantee_sec, map_=False, write_enabled=False):
+        """Initialize the channel."""
+        super(PLCChannel, self).__init__(mesh_name, data_type, chg_threshold, guarantee_sec, map_, write_enabled)
+        self.plc_ip = ip
+        self.mesh_name = mesh_name
+        self.plc_tag = plc_tag
+        self.data_type = data_type
+        self.last_value = None
+        self.value = None
+        self.last_send_time = 0
+        self.chg_threshold = chg_threshold
+        self.guarantee_sec = guarantee_sec
+        self.map_ = map_
+        self.write_enabled = write_enabled
+
+    def read(self):
+        """Read the value."""
+        plc_value = None
+        if self.plc_tag and self.plc_ip:
+            read_value = read_tag(self.plc_ip, self.plc_tag)
+            if read_value:
+                plc_value = read_value[0]
+
+        return plc_value
+
+
+class BoolArrayChannels(Channel):
+    """Hold the configuration for a set of boolean array channels."""
+
+    def __init__(self, ip, mesh_name, plc_tag, data_type, chg_threshold, guarantee_sec, map_=False, write_enabled=False):
+        """Initialize the channel."""
+        self.plc_ip = ip
+        self.mesh_name = mesh_name
+        self.plc_tag = plc_tag
+        self.data_type = data_type
+        self.last_value = None
+        self.value = None
+        self.last_send_time = 0
+        self.chg_threshold = chg_threshold
+        self.guarantee_sec = guarantee_sec
+        self.map_ = map_
+        self.write_enabled = write_enabled
+
+    def compare_values(self, new_val_dict):
+        """Compare new values to old values to see if the values need storing."""
+        send = False
+        for idx in new_val_dict:
+            try:
+                if new_val_dict[idx] != self.last_value[idx]:
+                    send = True
+            except KeyError:
+                print("Key Error in self.compare_values for index {}".format(idx))
+                send = True
+        return send
+
+    def read(self, force_send=False):
+        """Read the value and check to see if needs to be stored."""
+        send_needed = False
+        send_reason = ""
+        if self.plc_tag:
+            v = read_tag(self.plc_ip, self.plc_tag)
+            if v:
+                bool_arr = binarray(v[0])
+                new_val = {}
+                for idx in self.map_:
+                    try:
+                        new_val[self.map_[idx]] = bool_arr[idx]
+                    except KeyError:
+                        print("Not able to get value for index {}".format(idx))
+
+                if self.last_send_time == 0:
+                    send_needed = True
+                    send_reason = "no send time"
+                elif self.value is None:
+                    send_needed = True
+                    send_reason = "no value"
+                elif self.compare_values(new_val):
+                    send_needed = True
+                    send_reason = "value change"
+                elif (time.time() - self.last_send_time) > self.guarantee_sec:
+                    send_needed = True
+                    send_reason = "guarantee sec"
+                elif force_send:
+                    send_needed = True
+                    send_reason = "forced"
+
+                if send_needed:
+                    self.value = new_val
+                    self.last_value = self.value
+                    self.last_send_time = time.time()
+                    print("Sending {} for {} - {}".format(self.value, self.mesh_name, send_reason))
+        return send_needed

python-driver/config.txt

@@ -0,0 +1,11 @@
+{
+    "files": {
+        "file3": "modbusMap.p", 
+        "file2": "utilities.py", 
+        "file1": "promagmbs.py"
+    }, 
+    "deviceName": "promagmbs", 
+    "driverId": "0190", 
+    "releaseVersion": "2", 
+    "driverFileName": "promagmbs.py"
+}

python-driver/driverConfig.json

@@ -0,0 +1,11 @@
+{
+    "name": "promagmbs", 
+    "driverFilename": "promagmbs.py", 
+    "driverId": "0190", 
+    "additionalDriverFiles": [
+        "utilities.py", 
+        "modbusMap.p"
+    ], 
+    "version": 2, 
+    "s3BucketName": "promagmbs"
+}

python-driver/persistence.py

@@ -0,0 +1,21 @@
+"""Data persistance functions."""
+# if more advanced persistence is needed, use a sqlite database
+import json
+
+
+def load(filename="persist.json"):
+    """Load persisted settings from the specified file."""
+    try:
+        with open(filename, 'r') as persist_file:
+            return json.load(persist_file)
+    except Exception:
+        return False
+
+
+def store(persist_obj, filename="persist.json"):
+    """Store the persisting settings into the specified file."""
+    try:
+        with open(filename, 'w') as persist_file:
+            return json.dump(persist_obj, persist_file)
+    except Exception:
+        return False

python-driver/promagmbs.py

@@ -0,0 +1,75 @@
+"""Driver for promagmbs."""
+
+import threading
+from device_base import deviceBase
+from utilities import get_public_ip_address
+import time
+
+
+_ = None
+
+
+class start(threading.Thread, deviceBase):
+    """Start class required by Meshify."""
+
+    def __init__(self, name=None, number=None, mac=None, Q=None, mcu=None, companyId=None, offset=None, mqtt=None, Nodes=None):
+        """Initialize the driver."""
+        threading.Thread.__init__(self)
+        deviceBase.__init__(self, name=name, number=number, mac=mac, Q=Q, mcu=mcu, companyId=companyId, offset=offset, mqtt=mqtt, Nodes=Nodes)
+
+        self.daemon = True
+        self.version = "1"
+        self.finished = threading.Event()
+        self.forceSend = False
+        threading.Thread.start(self)
+
+    # this is a required function for all drivers, its goal is to upload some piece of data
+    # about your device so it can be seen on the web
+    def register(self):
+        """Register the driver."""
+        # self.sendtodb("log", "BOOM! Booted.", 0)
+        pass
+
+    def run(self):
+        # pass
+        """Actually run the driver."""
+        global persist
+        wait_sec = 60
+        for i in range(0, wait_sec):
+            print("promagmbs driver will start in {} seconds".format(wait_sec - i))
+            time.sleep(1)
+        print("BOOM! Starting promagmbs driver...")
+
+        public_ip_address = get_public_ip_address()
+        self.sendtodbDev(1, 'public_ip_address', public_ip_address, 0, 'promagmbs')
+
+        send_loops = 0
+        watchdog_loops = 0
+        watchdog_check_after = 5000
+        while True:
+            if self.forceSend:
+                print "FORCE SEND: TRUE"
+
+            print("promagmbs driver still alive...")
+            if self.forceSend:
+                if send_loops > 2:
+                    print("Turning off forceSend")
+                    self.forceSend = False
+                    send_loops = 0
+                else:
+                    send_loops += 1
+
+            watchdog_loops += 1
+            if (watchdog_loops >= watchdog_check_after):
+                test_public_ip = get_public_ip_address()
+                if not test_public_ip == public_ip_address:
+                    self.sendtodbDev(1, 'public_ip_address', test_public_ip, 0, 'promagmbs')
+                    public_ip_address = test_public_ip
+                watchdog_loops = 0
+            time.sleep(10)
+
+    def promagmbs_sync(self, name, value):
+        """Sync all data from the driver."""
+        self.forceSend = True
+        self.sendtodb("log", "synced", 0)
+        return True

python-driver/utilities.py

@@ -0,0 +1,41 @@
+"""Utility functions for the driver."""
+import socket
+import struct
+
+
+def get_public_ip_address():
+    """Find the public IP Address of the host device."""
+    s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+    s.connect(("8.8.8.8", 80))
+    ip = s.getsockname()[0]
+    s.close()
+    return ip
+
+
+def int_to_float16(int_to_convert):
+    """Convert integer into float16 representation."""
+    bin_rep = ('0' * 16 + '{0:b}'.format(int_to_convert))[-16:]
+
+    sign = -1 ** int(bin_rep[0])
+    exponent = int(bin_rep[1:6], 2)
+    fraction = int(bin_rep[7:17], 2)
+
+    return sign * 2 ** (exponent - 15) * float("1.{}".format(fraction))
+
+
+def ints_to_float(intlist):
+    """Convert 2 registers into a floating point number."""
+    mypack = struct.pack('>HH', intlist[0], intlist[1])
+    f = struct.unpack('>f', mypack)
+    print("{} >> {}".format(intlist, f[0]))
+    return f[0]
+
+
+def degf_to_degc(temp_f):
+    """Convert deg F to deg C."""
+    return (temp_f - 32.0) * (5.0/9.0)
+
+
+def degc_to_degf(temp_c):
+    """Convert deg C to deg F."""
+    return temp_c * 1.8 + 32.0