Add networking block

## [1.7.3](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/compare/v1.7.2...v1.7.3) (2021-04-12)

### Bug Fixes

* Empty commit to get recent changes into build (last commit should've been labeled this) ([e513752](e513752c46))

.gitlab-ci.yml

@@ -35,6 +35,8 @@ build:
     --pull
     --cache-from $CI_REGISTRY_IMAGE:latest
     --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
+    --build-arg BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ')
+    --build-arg VCS_REF=$CI_COMMIT_SHORT_SHA
     ./Docker/
   - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
 
@@ -81,7 +83,7 @@ release:
     - /^([0-9]+)\.([0-9]+)\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?$/ 
   script:
     - touch CHANGELOG.md
-    - npm install @semantic-release/gitlab @semantic-release/changelog
+    - npm install @semantic-release/gitlab @semantic-release/changelog @semantic-release/git
     - npx semantic-release
   artifacts:
     paths:
@@ -91,3 +93,20 @@ sast:
   stage: test
 include:
 - template: Security/SAST.gitlab-ci.yml
+
+sonarqube-check:
+  image: 
+    name: sonarsource/sonar-scanner-cli:latest
+    entrypoint: [""]
+  variables:
+    SONAR_USER_HOME: "${CI_PROJECT_DIR}/.sonar"  # Defines the location of the analysis task cache
+    GIT_DEPTH: "0"  # Tells git to fetch all the branches of the project, required by the analysis task
+  cache:
+    key: "${CI_JOB_NAME}"
+    paths:
+      - .sonar/cache
+  script: 
+    - sonar-scanner
+  allow_failure: true
+  only:
+    - master # or the name of your main branch

.releaserc.yml

@@ -4,6 +4,8 @@ plugins:
   - - "@semantic-release/changelog"
     - changelogFile: CHANGELOG.md
   - "@semantic-release/gitlab"
+  - - "@semantic-release/git"
+    - assets: CHANGELOG.md
 branches:
   - "master"
   - "+([0-9])?(.{+([0-9]),x}).x"

CHANGELOG.md

@@ -1,9 +1,24 @@
-# Changelog
+## [1.7.3](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/compare/v1.7.2...v1.7.3) (2021-04-12)
 
-All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+### Bug Fixes
+
+* Empty commit to get recent changes into build (last commit should've been labeled this) ([e513752](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/commit/e513752c46cc0b3beb93530f6549661d67196905))
+
+## [1.7.2](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/compare/v1.7.1...v1.7.2) (2021-04-08)
+
+
+### Bug Fixes
+
+* Cleanup CHANGELOG.md since using new semantic-release format ([a72ac7a](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/commit/a72ac7a1df91cb2231e38e8bbceb5ccf9c93328a))
+* fix asset info for git commit ([00c95c4](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/commit/00c95c42ea98921a1b2da9d2069d41e8e32f34f5))
+
+## [1.7.1](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/compare/v1.7.0...v1.7.1) (2021-04-08)
+
+
+### Bug Fixes
+
+* refactor Dockerfile to improve build ([40ac8c5](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/commit/40ac8c5ada9b993f53b72dcc14b2d9b7cd183e2f))
 
 ## [1.6.10] - 2021-04-06
 

Docker/Dockerfile

@@ -1,17 +1,26 @@
-FROM python:3.9.3-alpine3.12
-
+FROM python:3.9.4-alpine3.13
 LABEL maintainer="Evan Richardson (evanrich81[at]gmail.com)"
-LABEL version="1.6.6"
+
+ARG BUILD_DATE
+ARG VCS_REF
+
+LABEL org.label-schema.schema-version="1.0"
+LABEL org.label-schema.build-date=$BUILD_DATE
+LABEL org.label-schema.name="evanrich/py-eagle-mqtt"
+LABEL org.label-schema.description="Python Rainforest Eagle to MQTT Application"
+LABEL org.label-schema.vcs-url="https://github.com/evanrich/py-eagle-mqtt"
+LABEL org.label-schema.vcs-ref=$VCS_REF
+LABEL org.label-schema.vendor="Evan Richardson"
+LABEL org.label-schema.docker.cmd="docker run --name=py-eagle-mqtt -e MQTT_BROKER_IP=<IP> -e MQTT_BROKER_PORT=1883 -p 22042:22042 -d evanrich/py-eagle-mqtt"
 
 WORKDIR /app
-COPY . /app
+COPY requirements.txt /app
 COPY ./src/conf/logrotate/tHome /etc/logrotate.d/
 ENV PYTHONPATH=/app/src/python
 RUN apk --update add --no-cache logrotate \
 && pip3 install --no-cache-dir  --upgrade pip \
 && pip3 install --no-cache-dir -r requirements.txt
-#RUN rm -rf /var/cache/apk
-
+COPY . /app
 CMD ["/app/src/bin/tHome-eagle.py", "-c", "/app/src/conf"]
 
 EXPOSE 22042

Docker/src/bin/tHome-eagle.py

@@ -1,10 +1,10 @@
 #!/usr/bin/env python3
 
-#===========================================================================
+# ===========================================================================
 #
 # Eagle posting server 
 #
-#===========================================================================
+# ===========================================================================
 
 __doc__ = """
 Starts a small web server.  The Rain Forest Eagle is configured with
@@ -22,100 +22,116 @@ import json
 import bottle as B
 import tHome as T
 
-#===========================================================================
-def meter( client, data, cfg ):
+
+# ===========================================================================
+def meter(client, data, cfg):
     msg = {
-      "time" : data.TimeUnix,
-      "consumed" : data.Consumed, # kWh
-      "produced" : data.Produced, # kWh
+        "time": data.TimeUnix,
+        "consumed": data.Consumed,  # kWh
+        "produced": data.Produced,  # kWh
     }
 
-   return ( cfg.mqttEnergy, msg )
+    return cfg.mqttEnergy, msg
 
-#===========================================================================
-def instant( client, data, cfg ):
+
+# ===========================================================================
+def instant(client, data, cfg):
     msg = {
-      "time" : data.TimeUnix,
-      "power" : data.Power * 1000, # W
+        "time": data.TimeUnix,
+        "power": data.Power * 1000,  # W
     }
 
-   return ( cfg.mqttPower, msg )
+    return cfg.mqttPower, msg
 
-#===========================================================================
-def price( client, data, cfg ):
+
+# ===========================================================================
+def price(client, data, cfg):
     msg = {
-      "time" : data.TimeUnix,
-      "price" : data.Price,
-      "tier" : data.Tier,
+        "time": data.TimeUnix,
+        "price": data.Price,
+        "tier": data.Tier,
     }
-   return ( cfg.mqttPrice, msg )
+    return cfg.mqttPrice, msg
 
-#===========================================================================
+
+# ===========================================================================
+def network(client, data, cfg):
+    msg = {
+        "status": data.Status,
+        "description": data.Description,
+        "linkstrength": data.LinkStrength
+    }
+    return cfg.mqttNetwork, msg
+
+
+# ===========================================================================
 handlers = {
-   #"BlockPriceDetail" : 
-   "CurrentSummation" : meter,
-   #"DeviceInfo" : 
-   #"FastPollStatus" : 
-   "InstantaneousDemand" : instant,
-   #"MessageCluster" : 
-   #"MeterInfo" : 
-   #"NetworkInfo" : 
-   "PriceCluster" : price,
-   #"Reading" : 
-   #"ScheduleInfo" :
-   #"TimeCluster" : 
-   }
+    # "BlockPriceDetail" :
+    "CurrentSummation": meter,
+    # "DeviceInfo" :
+    # "FastPollStatus" :
+    "InstantaneousDemand": instant,
+    # "MessageCluster" :
+    # "MeterInfo" :
+    "NetworkInfo": network,
+    "PriceCluster": price,
+    # "Reading" :
+    # "ScheduleInfo" :
+    # "TimeCluster" :
+}
 
-#===========================================================================
 
-@B.post( '/' )
+# ===========================================================================
+
+@B.post('/')
 def root_post():
-   data = B.request.body.read( B.request.content_length )
+    data = B.request.body.read(B.request.content_length)
     try:
-      obj = T.eagle.parse( data )
+        obj = T.eagle.parse(data)
     except:
-      log.exception( "Error parsing Eagle posted data" )
+        log.exception("Error parsing Eagle posted data")
         return "ERROR"
 
-   log.info( "Read packet: %s" % obj.name )
+    log.info("Read packet: %s" % obj.name)
 
-   func = handlers.get( obj.name, None )
+    func = handlers.get(obj.name, None)
     if func:
-      topic, msg = func( client, obj, cfg )
+        topic, msg = func(client, obj, cfg)
         if msg:
-         log.info( "Publish: %s: %s" % ( topic, msg ) )
+            log.info("Publish: %s: %s" % (topic, msg))
 
-         payload = json.dumps( msg )
-         client.publish( topic, payload )
+            payload = json.dumps(msg)
+            client.publish(topic, payload)
 
     return "ok"
 
-#===========================================================================
+
+# ===========================================================================
 #
 # Main applications script
 #
-#===========================================================================
+# ===========================================================================
 
-p = argparse.ArgumentParser( prog=sys.argv[0],
-                             description="T-Home Eagle Server" )
-p.add_argument( "-c", "--configDir", metavar="configDir",
+p = argparse.ArgumentParser(prog=sys.argv[0],
+                            description="T-Home Eagle Server")
+p.add_argument("-c", "--configDir", metavar="configDir",
                default="/etc/tHome",
-                help="Configuration file directory." )
-p.add_argument( "-l", "--log", metavar="logFile",
+               help="Configuration file directory.")
+p.add_argument("-l", "--log", metavar="logFile",
                default=None, help="Logging file to use.  Input 'stdout' "
-                "to log to the screen." )
-c = p.parse_args( sys.argv[1:] )
+                                  "to log to the screen.")
+c = p.parse_args(sys.argv[1:])
 
 # Parse the eagle config file.
-cfg = T.eagle.config.parse( c.configDir )
-log = T.eagle.config.log( cfg, c.log )
+cfg = T.eagle.config.parse(c.configDir)
+log = T.eagle.config.log(cfg, c.log)
 
 # Create the MQTT client and connect it to the broker.
-client = T.broker.connect( c.configDir, log )
+client = T.broker.connect(c.configDir, log)
 
 # Start the MQTT as a background thread. This way we can run the web
 # server as the main thread here.
 client.loop_start()
 
-log.info( "Starting web server at port %d" % cfg.httpPort )
-B.run( host='0.0.0.0', port=cfg.httpPort, quiet=True )
+log.info("Starting web server at port %d" % cfg.httpPort)
+B.run(host='0.0.0.0', port=cfg.httpPort, quiet=True)

Docker/src/conf/eagle.py

@@ -23,6 +23,9 @@ mqttPrice = 'power/elec/Home/price'
 #Current rate label (returns rate label from meter)
 mqttRateLabel = 'power/elec/Home/ratelabel'
 
+#Network Info Topic (returns status, description and link strength from meter)
+mqttNetwork = 'power/elec/Home/network'
+
 #===========================================================================
 #
 # Logging configuration.  Env variables are allowed in the file name.

README.md

@@ -1,8 +1,17 @@
 # py-eagle-mqtt
+
 Python3 based Docker for Eagle to MQTT reader
 
 I have only ported this into a dockerfile, as well as made some changes to code for security or other purposes. All Original code is credit to [Ted Drain - TD22057](https://github.com/TD22057/T-Home).
 
+This project utilizes the following tools:
+
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/evanrich/py-eagle-mqtt)]()
+[![Gitlab pipeline status (self-hosted)](https://img.shields.io/gitlab/pipeline/erichardson/py-eagle-mqtt/master?gitlab_url=https%3A%2F%2Fgitlab.evanrichardsonphotography.com)]()
+[![Docker Pulls](https://img.shields.io/docker/pulls/evanrich/py-eagle-mqtt)]()
+[![Docker Image Version (latest by date)](https://img.shields.io/docker/v/evanrich/py-eagle-mqtt)]()
+
 ## UPDATES:
 
 2020-04-06: Moved Updates to a CHANGELOG.md file to clean this up.

sonar-project.properties

@@ -0,0 +1,3 @@
+sonar.projectKey=erichardson_py-eagle-mqtt_AXkgI9tRLcemhRz3NCjo
+sonar.qualitygate.wait=true
+sonar.projectBaseDir=Docker/src