install.py

# Copyright 2023 Michael Schantl and contributors
#
# 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 configobj

from weecfg.extension import ExtensionInstaller, ExtensionEngine


def loader() -> ExtensionInstaller:
    return MqttInstaller()


class MqttInstaller(ExtensionInstaller):
    def __init__(self) -> None:
        super().__init__(
            version="0.2.0",
            name='MQTT',
            description="Extension for uploading LOOP data to an MQTT broker",
            author='Michael Schantl',
            author_email="michael@schantl-lx.at",
            restful_services='user.mqtt.MqttService',
            files=[
                ('bin/user/mqtt', [
                    'bin/user/mqtt/__init__.py',
                    'bin/user/mqtt/configuration.py',
                ])
            ],
        )

    def configure(self, engine: ExtensionEngine) -> bool:
        config_dict: configobj.ConfigObj = engine.config_dict
        if 'StdRESTful' in config_dict and 'MQTT' in config_dict['StdRESTful']:
            return False

        mqtt_config = {
            "enable": "false",
            "host": "replace_me",
            "user": "replace_me",
            "password": "replace_me",
            "topic": "replace_me",
        }
        config_dict['StdRESTful']['MQTT'] = mqtt_config

        config_dict['StdRESTful'].comments['MQTT'] = [
            "", "Configuration for uploading LOOP data to an MQTT broker"]
        config_dict['StdRESTful']['MQTT'].comments['enable'] = [
            "", "Enable/disable this service"]
        config_dict['StdRESTful']['MQTT'].comments['host'] = [
            "", "Hostname/IP of MQTT broker"]
        config_dict['StdRESTful']['MQTT'].comments['user'] = [
            "", "Credentials"]
        config_dict['StdRESTful']['MQTT'].comments['topic'] = [
            "", "Prefix for topics"]

        return True