"""Handling of messages related to device firmware update."""
# Copyright 2019 WolkAbout Technology s.r.o.
#
# 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
from wolk_gateway_module.logger_factory import logger_factory
from wolk_gateway_module.model.firmware_update_status import (
FirmwareUpdateStatus,
)
from wolk_gateway_module.model.message import Message
from wolk_gateway_module.protocol.firmware_update_protocol import (
FirmwareUpdateProtocol,
)
[docs]class JsonFirmwareUpdateProtocol(FirmwareUpdateProtocol):
"""Parse inbound messages and serialize outbound firmware messages."""
DEVICE_PATH_PREFIX = "d/"
FIRMWARE_UPDATE_INSTALL_TOPIC_ROOT = "p2d/firmware_update_install/"
FIRMWARE_UPDATE_ABORT_TOPIC_ROOT = "p2d/firmware_update_abort/"
FIRMWARE_UPDATE_STATUS_TOPIC_ROOT = "d2p/firmware_update_status/"
FIRMWARE_VERSION_UPDATE_TOPIC_ROOT = "d2p/firmware_version_update/"
def __init__(self) -> None:
"""Create object."""
self.log = logger_factory.get_logger(str(self.__class__.__name__))
def __repr__(self) -> str:
"""
Make string representation of JsonFirmwareUpdateProtocol.
:returns: representation
:rtype: str
"""
return "JsonFirmwareUpdateProtocol()"
[docs] def get_inbound_topics_for_device(self, device_key: str) -> list:
"""
Return list of inbound topics for given device key.
:param device_key: Device key for which to create topics
:type device_key: str
:returns: inbound_topics
:rtype: list
"""
inbound_topics = [
self.FIRMWARE_UPDATE_INSTALL_TOPIC_ROOT
+ self.DEVICE_PATH_PREFIX
+ device_key,
self.FIRMWARE_UPDATE_ABORT_TOPIC_ROOT
+ self.DEVICE_PATH_PREFIX
+ device_key,
]
self.log.debug(f"Inbound topics for {device_key} : {inbound_topics}")
return inbound_topics
[docs] def make_update_message(
self, device_key: str, status: FirmwareUpdateStatus
) -> Message:
"""
Make message from device firmware update status.
:param device_key: Device key to which the firmware update status belongs to
:type device_key: str
:param status: Device firmware update status
:type status: FirmwareUpdateStatus
:returns: message
:rtype: Message
"""
topic = (
self.FIRMWARE_UPDATE_STATUS_TOPIC_ROOT
+ self.DEVICE_PATH_PREFIX
+ device_key
)
payload = {"status": status.status.value}
if status.error_code:
payload["error"] = status.error_code.value
message = Message(topic, json.dumps(payload))
self.log.debug(f"Made {message} from {status} and {device_key}")
return message
[docs] def make_version_message(
self, device_key: str, firmware_verison: str
) -> Message:
"""
Make message from device firmware update version.
:param device_key: Device key to which the firmware update belongs to
:type device_key: str
:param firmware_verison: Current firmware version
:type firmware_verison: str
:returns: message
:rtype: Message
"""
topic = (
self.FIRMWARE_VERSION_UPDATE_TOPIC_ROOT
+ self.DEVICE_PATH_PREFIX
+ device_key
)
payload = str(firmware_verison)
message = Message(topic, payload)
self.log.debug(
f"Made {message} from {firmware_verison} and {device_key}"
)
return message
[docs] def is_firmware_install_command(self, message: Message) -> bool:
"""
Check if received message is firmware install command.
:param message: Message received
:type message: Message
:returns: is_firmware_install_command
:rtype: bool
"""
is_firmware_install_command = message.topic.startswith(
self.FIRMWARE_UPDATE_INSTALL_TOPIC_ROOT
)
self.log.debug(
f"Is {message} firmware install command "
f"message: {is_firmware_install_command}"
)
return is_firmware_install_command
[docs] def is_firmware_abort_command(self, message: Message) -> bool:
"""
Check if received message is firmware abort command.
:param message: Message received
:type message: Message
:returns: is_firmware_abort_command
:rtype: bool
"""
is_firmware_abort_command = message.topic.startswith(
self.FIRMWARE_UPDATE_ABORT_TOPIC_ROOT
)
self.log.debug(
f"Is {message} firmware abort command "
f"message: {is_firmware_abort_command}"
)
return is_firmware_abort_command
[docs] def make_firmware_file_path(self, message: Message) -> str:
"""
Extract file path from firmware install message.
:param message: Message received
:type message: Message
:returns: firmware_file_path
:rtype: str
"""
payload = json.loads(message.payload) # type: ignore
firmware_file_path = payload["fileName"]
self.log.debug(f"Made {firmware_file_path} from {message}")
return firmware_file_path