mirror of
https://github.com/thingsboard/thingsboard-gateway
synced 2025-10-26 22:31:42 +08:00
593 lines
30 KiB
Python
593 lines
30 KiB
Python
# Copyright 2020. ThingsBoard
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import json
|
|
import time
|
|
import string
|
|
import random
|
|
from threading import Thread
|
|
from re import match, fullmatch, search
|
|
import ssl
|
|
from paho.mqtt.client import Client
|
|
from thingsboard_gateway.connectors.connector import Connector, log
|
|
from thingsboard_gateway.connectors.mqtt.json_mqtt_uplink_converter import JsonMqttUplinkConverter
|
|
from thingsboard_gateway.tb_utility.tb_utility import TBUtility
|
|
|
|
|
|
class MqttConnector(Connector, Thread):
|
|
def __init__(self, gateway, config, connector_type):
|
|
super().__init__()
|
|
|
|
self.__gateway = gateway # Reference to TB Gateway
|
|
self._connector_type = connector_type # Should be "mqtt"
|
|
self.config = config # mqtt.json contents
|
|
|
|
self.__log = log
|
|
self.statistics = {'MessagesReceived': 0, 'MessagesSent': 0}
|
|
self.__subscribes_sent = {}
|
|
|
|
# Extract main sections from configuration ---------------------------------------------------------------------
|
|
self.__broker = config.get('broker')
|
|
|
|
self.__mapping = []
|
|
self.__server_side_rpc = []
|
|
self.__connect_requests = []
|
|
self.__disconnect_requests = []
|
|
self.__attribute_requests = []
|
|
self.__attribute_updates = []
|
|
|
|
mandatory_keys = {
|
|
"mapping": ['topicFilter', 'converter'],
|
|
"serverSideRpc": ['deviceNameFilter', 'methodFilter'],
|
|
"connectRequests": ['topicFilter'],
|
|
"disconnectRequests": ['topicFilter'],
|
|
"attributeRequests": ['topicFilter', 'topicExpression', 'valueExpression'],
|
|
"attributeUpdates": ['deviceNameFilter', 'attributeFilter', 'topicExpression', 'valueExpression']
|
|
}
|
|
|
|
# Mappings, i.e., telemetry/attributes-push handlers provided by user via configuration file
|
|
self.load_handlers('mapping', mandatory_keys['mapping'], self.__mapping)
|
|
|
|
# RPCs, i.e., remote procedure calls (ThingsBoard towards devices) handlers
|
|
self.load_handlers('serverSideRpc', mandatory_keys['serverSideRpc'], self.__server_side_rpc)
|
|
|
|
# Connect requests, i.e., telling ThingsBoard that a device is online even if it does not post telemetry
|
|
self.load_handlers('connectRequests', mandatory_keys['connectRequests'], self.__connect_requests)
|
|
|
|
# Disconnect requests, i.e., telling ThingsBoard that a device is offline even if keep-alive has not expired yet
|
|
self.load_handlers('disconnectRequests', mandatory_keys['disconnectRequests'], self.__disconnect_requests)
|
|
|
|
# Shared attributes direct requests, i.e., asking ThingsBoard for some shared attribute value
|
|
self.load_handlers('attributeRequests', mandatory_keys['attributeRequests'], self.__attribute_requests)
|
|
|
|
# Attributes updates requests, i.e., asking ThingsBoard to send updates about an attribute
|
|
self.load_handlers('attributeUpdates', mandatory_keys['attributeUpdates'], self.__attribute_updates)
|
|
|
|
# Setup topic substitution lists for each class of handlers ----------------------------------------------------
|
|
self.__mapping_sub_topics = {}
|
|
self.__connect_requests_sub_topics = {}
|
|
self.__disconnect_requests_sub_topics = {}
|
|
self.__attribute_requests_sub_topics = {}
|
|
|
|
# Set up external MQTT broker connection -----------------------------------------------------------------------
|
|
client_id = ''.join(random.choice(string.ascii_lowercase) for _ in range(23))
|
|
self._client = Client(client_id)
|
|
self.setName(config.get("name", self.__broker.get(
|
|
"name",
|
|
'Mqtt Broker ' + ''.join(random.choice(string.ascii_lowercase) for _ in range(5)))))
|
|
|
|
if "username" in self.__broker["security"]:
|
|
self._client.username_pw_set(self.__broker["security"]["username"],
|
|
self.__broker["security"]["password"])
|
|
|
|
if "caCert" in self.__broker["security"] \
|
|
or self.__broker["security"].get("type", "none").lower() == "tls":
|
|
ca_cert = self.__broker["security"].get("caCert")
|
|
private_key = self.__broker["security"].get("privateKey")
|
|
cert = self.__broker["security"].get("cert")
|
|
|
|
if ca_cert is None:
|
|
self._client.tls_set_context(ssl.SSLContext(ssl.PROTOCOL_TLSv1_2))
|
|
else:
|
|
try:
|
|
self._client.tls_set(ca_certs=ca_cert,
|
|
certfile=cert,
|
|
keyfile=private_key,
|
|
cert_reqs=ssl.CERT_REQUIRED,
|
|
tls_version=ssl.PROTOCOL_TLSv1_2,
|
|
ciphers=None)
|
|
except Exception as e:
|
|
self.__log.error("Cannot setup connection to broker %s using SSL. "
|
|
"Please check your configuration.\nError: ",
|
|
self.get_name())
|
|
self.__log.exception(e)
|
|
self._client.tls_insecure_set(False)
|
|
|
|
# Set up external MQTT broker callbacks ------------------------------------------------------------------------
|
|
self._client.on_connect = self._on_connect
|
|
self._client.on_message = self._on_message
|
|
self._client.on_subscribe = self._on_subscribe
|
|
self._client.on_disconnect = self._on_disconnect
|
|
# self._client.on_log = self._on_log
|
|
|
|
# Set up lifecycle flags ---------------------------------------------------------------------------------------
|
|
self._connected = False
|
|
self.__stopped = False
|
|
self.daemon = True
|
|
|
|
def load_handlers(self, handler_flavor, mandatory_keys, accepted_handlers_list):
|
|
if handler_flavor not in self.config:
|
|
self.__log.error("'%s' section missing from configuration", handler_flavor)
|
|
else:
|
|
for handler in self.config.get(handler_flavor):
|
|
discard = False
|
|
|
|
for key in mandatory_keys:
|
|
if key not in handler:
|
|
# Will report all missing fields to user before discarding the entry => no break here
|
|
discard = True
|
|
self.__log.error("Mandatory key '%s' missing from %s handler: %s",
|
|
key, handler_flavor, json.dumps(handler))
|
|
else:
|
|
self.__log.debug("Mandatory key '%s' found in %s handler: %s",
|
|
key, handler_flavor, json.dumps(handler))
|
|
|
|
if discard:
|
|
self.__log.error("%s handler is missing some mandatory keys => rejected: %s",
|
|
handler_flavor, json.dumps(handler))
|
|
else:
|
|
accepted_handlers_list.append(handler)
|
|
self.__log.debug("%s handler has all mandatory keys => accepted: %s",
|
|
handler_flavor, json.dumps(handler))
|
|
|
|
self.__log.info("Number of accepted %s handlers: %d",
|
|
handler_flavor,
|
|
len(accepted_handlers_list))
|
|
|
|
self.__log.info("Number of rejected %s handlers: %d",
|
|
handler_flavor,
|
|
len(self.config.get(handler_flavor)) - len(accepted_handlers_list))
|
|
|
|
def is_connected(self):
|
|
return self._connected
|
|
|
|
def open(self):
|
|
self.__stopped = False
|
|
self.start()
|
|
|
|
def run(self):
|
|
try:
|
|
while not self._connected and not self.__stopped:
|
|
try:
|
|
self._client.connect(self.__broker['host'],
|
|
self.__broker.get('port', 1883))
|
|
self._client.loop_start()
|
|
if not self._connected:
|
|
time.sleep(1)
|
|
except ConnectionRefusedError as e:
|
|
self.__log.exception(e)
|
|
time.sleep(10)
|
|
|
|
except Exception as e:
|
|
self.__log.exception(e)
|
|
try:
|
|
self.close()
|
|
except Exception as e:
|
|
self.__log.exception(e)
|
|
while True:
|
|
if self.__stopped:
|
|
break
|
|
time.sleep(.01)
|
|
|
|
def close(self):
|
|
self.__stopped = True
|
|
try:
|
|
self._client.disconnect()
|
|
except Exception as e:
|
|
log.exception(e)
|
|
self._client.loop_stop()
|
|
self.__log.info('%s has been stopped.', self.get_name())
|
|
|
|
def get_name(self):
|
|
return self.name
|
|
|
|
def __subscribe(self, topic, qos):
|
|
message = self._client.subscribe(topic, qos)
|
|
try:
|
|
self.__subscribes_sent[message[1]] = topic
|
|
except Exception as e:
|
|
self.__log.exception(e)
|
|
|
|
def _on_connect(self, client, userdata, flags, result_code, *extra_params):
|
|
|
|
result_codes = {
|
|
1: "incorrect protocol version",
|
|
2: "invalid client identifier",
|
|
3: "server unavailable",
|
|
4: "bad username or password",
|
|
5: "not authorised",
|
|
}
|
|
|
|
if result_code == 0:
|
|
self._connected = True
|
|
self.__log.info('%s connected to %s:%s - successfully.',
|
|
self.get_name(),
|
|
self.__broker["host"],
|
|
self.__broker.get("port", "1883"))
|
|
|
|
self.__log.debug("Client %s, userdata %s, flags %s, extra_params %s",
|
|
str(client),
|
|
str(userdata),
|
|
str(flags),
|
|
extra_params)
|
|
|
|
# Setup data upload requests handling ----------------------------------------------------------------------
|
|
for mapping in self.__mapping:
|
|
try:
|
|
# Load converter for this mapping entry ------------------------------------------------------------
|
|
# mappings are guaranteed to have topicFilter and converter fields. See __init__
|
|
default_converter_class_name = "JsonMqttUplinkConverter"
|
|
# Get converter class from "extension" parameter or default converter
|
|
converter_class_name = mapping["converter"].get("extension", default_converter_class_name)
|
|
# Find and load required class
|
|
module = TBUtility.check_and_import(self._connector_type, converter_class_name)
|
|
if module:
|
|
self.__log.debug('Converter %s for topic %s - found!', converter_class_name, mapping["topicFilter"])
|
|
converter = module(mapping)
|
|
else:
|
|
self.__log.error("Cannot find converter for %s topic", mapping["topicFilter"])
|
|
continue
|
|
|
|
# Setup regexp topic acceptance list ---------------------------------------------------------------
|
|
regex_topic = TBUtility.topic_to_regex(mapping["topicFilter"])
|
|
|
|
# There may be more than one converter per topic, so I'm using vectors
|
|
if not self.__mapping_sub_topics.get(regex_topic):
|
|
self.__mapping_sub_topics[regex_topic] = []
|
|
|
|
self.__mapping_sub_topics[regex_topic].append(converter)
|
|
|
|
# Subscribe to appropriate topic -------------------------------------------------------------------
|
|
self.__subscribe(mapping["topicFilter"], mapping.get("subscriptionQos", 0))
|
|
|
|
self.__log.info('Connector "%s" subscribe to %s',
|
|
self.get_name(),
|
|
TBUtility.regex_to_topic(regex_topic))
|
|
|
|
except Exception as e:
|
|
self.__log.exception(e)
|
|
|
|
# Setup connection requests handling -----------------------------------------------------------------------
|
|
for request in [entry for entry in self.__connect_requests if entry is not None]:
|
|
# requests are guaranteed to have topicFilter field. See __init__
|
|
self.__subscribe(request["topicFilter"], request.get("subscriptionQos", 0))
|
|
topic_filter = TBUtility.topic_to_regex(request.get("topicFilter"))
|
|
self.__connect_requests_sub_topics[topic_filter] = request
|
|
|
|
# Setup disconnection requests handling --------------------------------------------------------------------
|
|
for request in [entry for entry in self.__disconnect_requests if entry is not None]:
|
|
# requests are guaranteed to have topicFilter field. See __init__
|
|
self.__subscribe(request["topicFilter"], request.get("subscriptionQos", 0))
|
|
topic_filter = TBUtility.topic_to_regex(request.get("topicFilter"))
|
|
self.__disconnect_requests_sub_topics[topic_filter] = request
|
|
|
|
# Setup attributes requests handling -----------------------------------------------------------------------
|
|
for request in [entry for entry in self.__attribute_requests if entry is not None]:
|
|
# requests are guaranteed to have topicFilter field. See __init__
|
|
self.__subscribe(request["topicFilter"], request.get("subscriptionQos", 0))
|
|
topic_filter = TBUtility.topic_to_regex(request.get("topicFilter"))
|
|
self.__attribute_requests_sub_topics[topic_filter] = request
|
|
|
|
else:
|
|
if result_code in result_codes:
|
|
self.__log.error("%s connection FAIL with error %s %s!", self.get_name(), result_code, result_codes[result_code])
|
|
else:
|
|
self.__log.error("%s connection FAIL with unknown error!", self.get_name())
|
|
|
|
def _on_disconnect(self, *args):
|
|
self.__log.debug('"%s" was disconnected. %s', self.get_name(), str(args))
|
|
|
|
def _on_log(self, *args):
|
|
self.__log.debug(args)
|
|
|
|
def _on_subscribe(self, _, __, mid, granted_qos):
|
|
try:
|
|
if granted_qos[0] == 128:
|
|
self.__log.error('"%s" subscription failed to topic %s subscription message id = %i',
|
|
self.get_name(),
|
|
self.__subscribes_sent.get(mid), mid)
|
|
else:
|
|
self.__log.info('"%s" subscription success to topic %s, subscription message id = %i',
|
|
self.get_name(),
|
|
self.__subscribes_sent.get(mid), mid)
|
|
|
|
if self.__subscribes_sent.get(mid) is not None:
|
|
del self.__subscribes_sent[mid]
|
|
except Exception as e:
|
|
self.__log.exception(e)
|
|
|
|
def _on_message(self, client, userdata, message):
|
|
self.statistics['MessagesReceived'] += 1
|
|
content = TBUtility.decode(message)
|
|
|
|
# Check if message topic exists in mappings "i.e., I'm posting telemetry/attributes" ---------------------------
|
|
topic_handlers = [regex for regex in self.__mapping_sub_topics if fullmatch(regex, message.topic)]
|
|
|
|
if topic_handlers:
|
|
# Note: every topic may be associated to one or more converter. This means that a single MQTT message
|
|
# may produce more than one message towards ThingsBoard. This also means that I cannot return after
|
|
# the first successful conversion: I got to use all the available ones.
|
|
# I will use a flag to understand whether at least one converter succeeded
|
|
request_handled = False
|
|
|
|
for topic in topic_handlers:
|
|
available_converters = self.__mapping_sub_topics[topic]
|
|
for converter in available_converters:
|
|
converted_content = converter.convert(message.topic, content)
|
|
|
|
if converted_content:
|
|
request_handled = True
|
|
self.__gateway.send_to_storage(self.name, converted_content)
|
|
self.statistics['MessagesSent'] += 1
|
|
self.__log.info("Successfully converted message from topic %s", message.topic)
|
|
else:
|
|
continue
|
|
|
|
if not request_handled:
|
|
self.__log.error('Cannot find converter for the topic:"%s"! Client: %s, User data: %s',
|
|
message.topic,
|
|
str(client),
|
|
str(userdata))
|
|
|
|
# Note: if I'm in this branch, this was for sure a telemetry/attribute push message
|
|
# => Execution must end here both in case of failure and success
|
|
return None
|
|
|
|
# Check if message topic exists in connection handlers "i.e., I'm connecting a device" -------------------------
|
|
topic_handlers = [regex for regex in self.__connect_requests_sub_topics if fullmatch(regex, message.topic)]
|
|
|
|
if topic_handlers:
|
|
for topic in topic_handlers:
|
|
handler = self.__connect_requests_sub_topics[topic]
|
|
|
|
found_device_name = None
|
|
found_device_type = 'default'
|
|
|
|
# Get device name, either from topic or from content
|
|
if handler.get("deviceNameTopicExpression"):
|
|
device_name_match = search(handler["deviceNameTopicExpression"], message.topic)
|
|
if device_name_match is not None:
|
|
found_device_name = device_name_match.group(0)
|
|
elif handler.get("deviceNameJsonExpression"):
|
|
found_device_name = TBUtility.get_value(handler["deviceNameJsonExpression"], content)
|
|
|
|
# Get device type (if any), either from topic or from content
|
|
if handler.get("deviceTypeTopicExpression"):
|
|
device_type_match = search(handler["deviceTypeTopicExpression"], message.topic)
|
|
if device_type_match is not None:
|
|
found_device_type = device_type_match.group(0)
|
|
elif handler.get("deviceTypeJsonExpression"):
|
|
found_device_type = TBUtility.get_value(handler["deviceTypeJsonExpression"], content)
|
|
|
|
if found_device_name is None:
|
|
self.__log.error("Device name missing from connection request")
|
|
continue
|
|
|
|
# Note: device must be added even if it is already known locally: else ThingsBoard
|
|
# will not send RPCs and attribute updates
|
|
self.__log.info("Connecting device %s of type %s", found_device_name, found_device_type)
|
|
self.__gateway.add_device(found_device_name, {"connector": self}, device_type=found_device_type)
|
|
|
|
# Note: if I'm in this branch, this was for sure a connection message
|
|
# => Execution must end here both in case of failure and success
|
|
return None
|
|
|
|
# Check if message topic exists in disconnection handlers "i.e., I'm disconnecting a device" -------------------
|
|
topic_handlers = [regex for regex in self.__disconnect_requests_sub_topics if fullmatch(regex, message.topic)]
|
|
if topic_handlers:
|
|
for topic in topic_handlers:
|
|
handler = self.__disconnect_requests_sub_topics[topic]
|
|
|
|
found_device_name = None
|
|
found_device_type = 'default'
|
|
|
|
# Get device name, either from topic or from content
|
|
if handler.get("deviceNameTopicExpression"):
|
|
device_name_match = search(handler["deviceNameTopicExpression"], message.topic)
|
|
if device_name_match is not None:
|
|
found_device_name = device_name_match.group(0)
|
|
elif handler.get("deviceNameJsonExpression"):
|
|
found_device_name = TBUtility.get_value(handler["deviceNameJsonExpression"], content)
|
|
|
|
# Get device type (if any), either from topic or from content
|
|
if handler.get("deviceTypeTopicExpression"):
|
|
device_type_match = search(handler["deviceTypeTopicExpression"], message.topic)
|
|
if device_type_match is not None:
|
|
found_device_type = device_type_match.group(0)
|
|
elif handler.get("deviceTypeJsonExpression"):
|
|
found_device_type = TBUtility.get_value(handler["deviceTypeJsonExpression"], content)
|
|
|
|
if found_device_name is None:
|
|
self.__log.error("Device name missing from disconnection request")
|
|
continue
|
|
|
|
if found_device_name in self.__gateway.get_devices():
|
|
self.__log.info("Disconnecting device %s of type %s", found_device_name, found_device_type)
|
|
self.__gateway.del_device(found_device_name)
|
|
else:
|
|
self.__log.info("Device %s was not connected", found_device_name)
|
|
|
|
break
|
|
|
|
# Note: if I'm in this branch, this was for sure a disconnection message
|
|
# => Execution must end here both in case of failure and success
|
|
return None
|
|
|
|
# Check if message topic exists in attribute request handlers "i.e., I'm asking for a shared attribute" --------
|
|
topic_handlers = [regex for regex in self.__attribute_requests_sub_topics if fullmatch(regex, message.topic)]
|
|
if topic_handlers:
|
|
try:
|
|
for topic in topic_handlers:
|
|
handler = self.__attribute_requests_sub_topics[topic]
|
|
|
|
found_device_name = None
|
|
found_attribute_name = None
|
|
|
|
# Get device name, either from topic or from content
|
|
if handler.get("deviceNameTopicExpression"):
|
|
device_name_match = search(handler["deviceNameTopicExpression"], message.topic)
|
|
if device_name_match is not None:
|
|
found_device_name = device_name_match.group(0)
|
|
elif handler.get("deviceNameJsonExpression"):
|
|
found_device_name = TBUtility.get_value(handler["deviceNameJsonExpression"], content)
|
|
|
|
# Get attribute name, either from topic or from content
|
|
if handler.get("attributeNameTopicExpression"):
|
|
attribute_name_match = search(handler["attributeNameTopicExpression"], message.topic)
|
|
if attribute_name_match is not None:
|
|
found_attribute_name = attribute_name_match.group(0)
|
|
elif handler.get("attributeNameJsonExpression"):
|
|
found_attribute_name = TBUtility.get_value(handler["attributeNameJsonExpression"], content)
|
|
|
|
if found_device_name is None:
|
|
self.__log.error("Device name missing from attribute request")
|
|
continue
|
|
|
|
if found_attribute_name is None:
|
|
self.__log.error("Attribute name missing from attribute request")
|
|
continue
|
|
|
|
self.__log.info("Will retrieve attribute %s of %s", found_attribute_name, found_device_name)
|
|
self.__gateway.tb_client.client.gw_request_shared_attributes(
|
|
found_device_name,
|
|
[found_attribute_name],
|
|
lambda data, *args: self.notify_attribute(
|
|
data,
|
|
found_attribute_name,
|
|
handler.get("topicExpression"),
|
|
handler.get("valueExpression")))
|
|
|
|
break
|
|
|
|
except Exception as e:
|
|
log.exception(e)
|
|
|
|
# Note: if I'm in this branch, this was for sure an attribute request message
|
|
# => Execution must end here both in case of failure and success
|
|
return None
|
|
|
|
# Check if message topic exists in RPC handlers ----------------------------------------------------------------
|
|
# The gateway is expecting for this message => no wildcards here, the topic must be evaluated as is
|
|
if message.topic in self.__gateway.rpc_requests_in_progress:
|
|
self.__gateway.rpc_with_reply_processing(message.topic, content)
|
|
return None
|
|
|
|
self.__log.debug("Received message to topic \"%s\" with unknown interpreter data: \n\n\"%s\"",
|
|
message.topic,
|
|
content)
|
|
|
|
def notify_attribute(self, incoming_data, attribute_name, topic_expression, value_expression):
|
|
if incoming_data.get("device") is None or incoming_data.get("value") is None:
|
|
return
|
|
|
|
device_name = incoming_data.get("device")
|
|
attribute_value = incoming_data.get("value")
|
|
|
|
topic = topic_expression \
|
|
.replace("${deviceName}", device_name) \
|
|
.replace("${attributeKey}", attribute_name)
|
|
|
|
data = value_expression.replace("${attributeKey}", attribute_name) \
|
|
.replace("${attributeValue}", attribute_value)
|
|
|
|
self._client.publish(topic, data).wait_for_publish()
|
|
|
|
def on_attributes_update(self, content):
|
|
if self.__attribute_updates:
|
|
for attribute_update in self.__attribute_updates:
|
|
if match(attribute_update["deviceNameFilter"], content["device"]):
|
|
for attribute_key in content["data"]:
|
|
if match(attribute_update["attributeFilter"], attribute_key):
|
|
try:
|
|
topic = attribute_update["topicExpression"]\
|
|
.replace("${deviceName}", content["device"])\
|
|
.replace("${attributeKey}", attribute_key)\
|
|
.replace("${attributeValue}", content["data"][attribute_key])
|
|
except KeyError as e:
|
|
log.exception("Cannot form topic, key %s - not found", e)
|
|
raise e
|
|
try:
|
|
data = attribute_update["valueExpression"]\
|
|
.replace("${attributeKey}", attribute_key)\
|
|
.replace("${attributeValue}", content["data"][attribute_key])
|
|
except KeyError as e:
|
|
log.exception("Cannot form topic, key %s - not found", e)
|
|
raise e
|
|
self._client.publish(topic, data).wait_for_publish()
|
|
self.__log.debug("Attribute Update data: %s for device %s to topic: %s", data, content["device"], topic)
|
|
else:
|
|
self.__log.error("Cannot find attributeName by filter in message with data: %s", content)
|
|
else:
|
|
self.__log.error("Cannot find deviceName by filter in message with data: %s", content)
|
|
else:
|
|
self.__log.error("Attribute updates config not found.")
|
|
|
|
def server_side_rpc_handler(self, content):
|
|
for rpc_config in self.__server_side_rpc:
|
|
if search(rpc_config["deviceNameFilter"], content["device"]) \
|
|
and search(rpc_config["methodFilter"], content["data"]["method"]) is not None:
|
|
# Subscribe to RPC response topic
|
|
if rpc_config.get("responseTopicExpression"):
|
|
topic_for_subscribe = rpc_config["responseTopicExpression"] \
|
|
.replace("${deviceName}", content["device"]) \
|
|
.replace("${methodName}", content["data"]["method"]) \
|
|
.replace("${requestId}", str(content["data"]["id"])) \
|
|
.replace("${params}", content["data"]["params"])
|
|
if rpc_config.get("responseTimeout"):
|
|
timeout = time.time()*1000+rpc_config.get("responseTimeout")
|
|
self.__gateway.register_rpc_request_timeout(content,
|
|
timeout,
|
|
topic_for_subscribe,
|
|
self.rpc_cancel_processing)
|
|
# Maybe we need to wait for the command to execute successfully before publishing the request.
|
|
self._client.subscribe(topic_for_subscribe)
|
|
else:
|
|
self.__log.error("Not found RPC response timeout in config, sending without waiting for response")
|
|
# Publish RPC request
|
|
if rpc_config.get("requestTopicExpression") is not None\
|
|
and rpc_config.get("valueExpression"):
|
|
topic = rpc_config.get("requestTopicExpression")\
|
|
.replace("${deviceName}", content["device"])\
|
|
.replace("${methodName}", content["data"]["method"])\
|
|
.replace("${requestId}", str(content["data"]["id"]))\
|
|
.replace("${params}", content["data"]["params"])
|
|
data_to_send = rpc_config.get("valueExpression")\
|
|
.replace("${deviceName}", content["device"])\
|
|
.replace("${methodName}", content["data"]["method"])\
|
|
.replace("${requestId}", str(content["data"]["id"]))\
|
|
.replace("${params}", content["data"]["params"])
|
|
try:
|
|
self._client.publish(topic, data_to_send)
|
|
self.__log.debug("Send RPC with no response request to topic: %s with data %s",
|
|
topic,
|
|
data_to_send)
|
|
if rpc_config.get("responseTopicExpression") is None:
|
|
self.__gateway.send_rpc_reply(device=content["device"], req_id=content["data"]["id"], success_sent=True)
|
|
except Exception as e:
|
|
self.__log.exception(e)
|
|
|
|
def rpc_cancel_processing(self, topic):
|
|
self._client.unsubscribe(topic)
|
|
|