Metadata-Version: 1.1
Name: mystrom2mqtt
Version: 0.1.0
Summary: Transfer HTTP requests from myStrom devices to MQTT
Home-page: https://github.com/home-assistant-ecosystem/mystrom2mqtt
Author: Fabian Affolter
Author-email: fabian@affolter-engineering.ch
License: ASL 2.0
Description: myStrom2MQTT
        ============
        
        `myStrom <https://mystrom.ch>`_ buttons allows to send HTTP requests. If a press
        pattern is applied then a request is send to a devices. 
        
        This module is not official, developed, supported or endorsed by myStrom AG.
        
        For questions and other inquiries, use the issue tracker in this repository please.
        
        myStrom AG has provided and is still providing hardware for testing and development.
        
        Supported home automation platforms
        -----------------------------------
        
        Add the moment the following platforms are supported:
        
        - `Home Assistant <https://home-assistant.io>`_
        
        Requirements
        ------------
        
        You need to have `Python <https://www.python.org>`_ installed.
        
        - `myStrom <https://mystrom.ch>`_ button (button or button+, could work with the Motion sensor too)
        - A MQTT broker
        - Network connection
        - Devices connected to your network
        
        Installation
        ------------
        
        The package is available in the `Python Package Index <https://pypi.python.org/>`_ .
        
        .. code:: bash
        
            $ pip3 install mystrom2mqtt
        
        Usage
        -----
        
        Set the target of the button. The port which is used by ``mystrom2mqtt`` is 8321.
        
        .. code:: bash
        
           curl --location --request POST 'http://[IP of the button]/api/v1/action/generic' \
             --data-raw 'post://[mystrom2mqtt host]:8321'
        
        A configuration file is needed. The format is TOML and the default name ``config.toml``.
        
        .. code:: bash
        
           [mystrom2mqtt]
           broker = "192.168.0.20"
           port = 1883
           username = "mqtt"
           password = "mqtt"
        
        To start ```mystrom2mqtt`` specify the path with ``-c, --config`` to the configuration
        file:
        
        .. code:: bash
        
           mystrom2mqtt -c path/to/config.toml
        
        
        To autostart ``mystrom2mqtt`` create a systemd unit file named ``/etc/systemd/system/mystrom2mqtt.service``
        with the parameters you 
        
        .. code:: bash
        
           [Unit]
           Description=myStrom2MQTT
           After=network-online.target
           
           [Service]
           Type=simple
           ExecStart=/usr/bin/mystrom2mqtt -c "/path/to/config.toml"
           
           [Install]
           WantedBy=multi-user.target
        
        
        License
        -------
        
        ``mystrom2mqtt`` is licensed under ASL 2.0, for more details check LICENSE.
        
Keywords: iot mystrom mqtt homeassistant
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
