Skip to content

Commit

Permalink
Changed: MQTT data can be send per topic or as json data per input
Browse files Browse the repository at this point in the history 
Fixed: If serialport timeout is defined, it will restart the port
  • Loading branch information
@ualex73
ualex73 committed May 12, 2019
1 parent fe0d679 commit 6e6c52a
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 19 deletions.
5 changes: 4 additions & 1 deletion app/configuration.yaml.example
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,16 @@ mqtt:
# Port of the MQTT broker. Normally 1883 or 8883 (TLS)
port: 1883
# Basictopic to use to publish the values
basetopic: s0pcmreader
base_topic: s0pcmreader
# Username and password required to connect to the MQTT broker
#username: s0pcmreader
#password: password
# If a client id should be used, if not configured - a random value will be used
#client_id: <random>
# If messages should have the retain flag. Default it is yes.
#retain: yes
# If values should be send per topic, or combine them into a json string as much as possible
#split_topic: yes

# TLSv1/1.1/1.2 Configuration
# Enable TLS, without a "tls_ca" it still connects, but no certificate verification is done.
Expand Down Expand Up @@ -61,6 +63,7 @@ s0pcm:
# Default is to follow the S0PCM packet interval (10 seconds).
#publish_interval: 10
# If only changes should be published. Default is yes.
# NOTE: This is disabled when 'split_topic=no' is configured.
#publish_onchange: yes

# If enabled, which input should be counted/used, all other ones are ignored.
Expand Down
59 changes: 46 additions & 13 deletions app/s0pcm-reader.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import ssl
import argparse
import copy
import json

"""
Description
Expand Down Expand Up @@ -61,7 +62,7 @@
MQTT
----
MQTT Topic:
MQTT Topic - when split_topic=yes (default):
base_topic/status - online/offline
base_topic/error - if any?
base_topic/1/total
Expand All @@ -71,6 +72,12 @@
base_topic/X/today
base_topic/X/yesterday
MQTT Topic - when split_topic=no:
base_topic/status - online/offline
base_topic/error - if any?
base_topic/1 - json string e.g. '{"total": 12345, "today": 15, "yesterday": 77}'
base_topic/X - json string e.g. '{"total": 12345, "today": 15, "yesterday": 77}'
"""

# ------------------------------------------------------------------------------------
Expand Down Expand Up @@ -107,8 +114,9 @@
# ------------------------------------------------------------------------------------
# Logging
# ------------------------------------------------------------------------------------
logging.basicConfig(level=logging.DEBUG, format='%(asctime)s %(levelname)s: %(message)s')
logging.basicConfig(level=logging.ERROR, format='%(asctime)s %(levelname)s: %(message)s')
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
logger.propagate = False

# ------------------------------------------------------------------------------------
Expand Down Expand Up @@ -167,7 +175,11 @@ def ReadConfig():
if not 'client_id' in config['mqtt']: config['mqtt']['client_id'] = None
if not 'version' in config['mqtt']: config['mqtt']['version'] = mqtt.MQTTv311
if not 'retain' in config['mqtt']: config['mqtt']['retain'] = True
if not 'split_topic' in config['mqtt']: config['mqtt']['split_topic'] = True
if not 'connect_retry' in config['mqtt']: config['mqtt']['connect_retry'] = 5
if not 'online' in config['mqtt']: config['mqtt']['online'] = 'online'
if not 'offline' in config['mqtt']: config['mqtt']['offline'] = 'offline'
if not 'lastwill' in config['mqtt']: config['mqtt']['lastwill'] = 'offline'

if str(config['mqtt']['version']) == '3.1':
config['mqtt']['version'] = mqtt.MQTTv31
Expand Down Expand Up @@ -287,9 +299,11 @@ def ReadSerial(self):
break

# check if there is data received
# If there is really nothing, most likely a timeout on reading the input data
if len(datain) == 0:
logger.error('Failed to read data (nothing received)')
continue
logger.error('Failed to read any data (timeout)')
ser.close()
break

# need to decode the data to ascii string
try:
Expand Down Expand Up @@ -435,7 +449,7 @@ def on_connect(self, mqttc, obj, flags, rc):
if rc == 0:
self._connected = True
logger.debug('MQTT successfully connected to broker')
self._mqttc.publish(config['mqtt']['base_topic'] + '/status', 'online', retain=config['mqtt']['retain'])
self._mqttc.publish(config['mqtt']['base_topic'] + '/status', config['mqtt']['online'], retain=config['mqtt']['retain'])
else:
self._connected = False

Expand Down Expand Up @@ -494,7 +508,7 @@ def DoMQTT(self):
self._mqttc.tls_set_context(context=context)

# Set last will
self._mqttc.will_set(config['mqtt']['base_topic'] + '/status', 'offline', retain=config['mqtt']['retain'])
self._mqttc.will_set(config['mqtt']['base_topic'] + '/status', config['mqtt']['lastwill'], retain=config['mqtt']['retain'])

while not self._stopper.is_set():

Expand Down Expand Up @@ -537,6 +551,10 @@ def DoMQTT(self):

for key in measurementlocal:
if isinstance(key, int):

# define dict for json value
jsondata = {}

try:
if not measurement[key]['enabled']:
continue
Expand Down Expand Up @@ -564,17 +582,32 @@ def DoMQTT(self):

try:
if subkey in measurementlocal[key]:
# Check if the value not changed and publish on change is off
if measurementlocal[key][subkey] == value_previous and config['s0pcm']['publish_onchange'] == True:
continue

logger.debug('MQTT Publish of topic \'%s\' and value \'%s\'',config['mqtt']['base_topic'] + '/' + instancename + '/' + subkey,str(measurementlocal[key][subkey]))
if config['mqtt']['split_topic'] == True:
# Check if the value not changed and publish on change is off
if measurementlocal[key][subkey] == value_previous and config['s0pcm']['publish_onchange'] == True:
continue

logger.debug('MQTT Publish of topic \'%s\' and value \'%s\'',config['mqtt']['base_topic'] + '/' + instancename + '/' + subkey, str(measurementlocal[key][subkey]))

# Do a MQTT Publish
self._mqttc.publish(config['mqtt']['base_topic'] + '/' + instancename + '/' + subkey, measurementlocal[key][subkey], retain=config['mqtt']['retain'])
else:
jsondata[subkey] = measurementlocal[key][subkey]

# Do a MQTT Publish
self._mqttc.publish(config['mqtt']['base_topic'] + '/' + instancename + '/' + subkey, measurementlocal[key][subkey], retain=config['mqtt']['retain'])
except Exception as e:
logger.error('MQTT Publish Failed. Key=%s, SubKey=%s. %s: \'%s\'', str(key), subkey, type(e).__name__, str(e))

# We should publish the json value
if config['mqtt']['split_topic'] == False:
try:
logger.debug('MQTT Publish of topic \'%s\' and value \'%s\'',config['mqtt']['base_topic'] + '/' + instancename, json.dumps(jsondata))

# Do a MQTT Publish
self._mqttc.publish(config['mqtt']['base_topic'] + '/' + instancename, json.dumps(jsondata), retain=config['mqtt']['retain'])
except Exception as e:
logger.error('MQTT Publish Failed. %s: \'%s\'', type(e).__name__, str(e))

# Lets make also a copy of this one, then we can compare if there is a delta
measurementprevious = copy.deepcopy(measurementlocal)

Expand All @@ -586,7 +619,7 @@ def DoMQTT(self):

# Send an official offline message
if self._connected:
self._mqttc.publish(config['mqtt']['base_topic'] + '/status', 'offline', retain=config['mqtt']['retain'])
self._mqttc.publish(config['mqtt']['base_topic'] + '/status', config['mqtt']['offline'], retain=config['mqtt']['retain'])

self._mqttc.disconnect()

Expand Down
7 changes: 2 additions & 5 deletions build.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,17 @@

VERSION=$1

if [ ! -z "$VERSION" ]; then
VERSION="-${VERSION}"
fi

for ARCH in amd64 arm32v6 arm64v8
do
docker build -f Dockerfile.${ARCH} -t ualex73/s0pcm-reader:${ARCH} .

# Tag it with a version
if [ ! -z "$VERSION" ]; then
docker tag ualex73/s0pcm-reader:${ARCH} ualex73/s0pcm-reader:${ARCH}${VERSION}
docker tag ualex73/s0pcm-reader:${ARCH} ualex73/s0pcm-reader:${ARCH}-${VERSION}
fi
done

if [ ! -z "$VERSION" ]; then
docker tag ualex73/s0pcm-reader:amd64 ualex73/s0pcm-reader:latest
docker tag ualex73/s0pcm-reader:amd64 ualex73/s0pcm-reader:$VERSION
fi

0 comments on commit 6e6c52a

Please sign in to comment.