Metadata-Version: 2.1
Name: iot_gw
Version: 0.1.dev44
Summary: IoT gateway
Home-page: https://github.com/arnlec/iot-gw
Author: A. LE CANN
Author-email: arnaud@lecann.com
License: GPLv3
Description: # IoT Gateway
        
        IoT gateway is a device that connects its client devices to a IoT platforms.
        
        ```plantuml
        @startditaa                                        
        +--------+        +---------+    I2     +----------+
        |        |   I1   |         +<----------+   IoT    |
        | Device +<------>+ Gateway +   Bridge  | Platform | 
        |        |        |         |---------->|          |
        +--------+        +---------+ telemetry +----------+
                                        state
        @endditaa
        ```
        
        
        
        ## Interface I1
        
        Interface between Device and Gateway
        
        Protocol: MQTT
        
        Mqtt topics:
        * Attach
        * Unattach
        * State
        * Event
        * Config
        * Commands
        
        ### Attach topic
        * **Topic name:** /attach
        * **Payload:** device id as string
        * **Source:** device
        
        ### Unattach topic
        * **Topic name:** /unattach
        * **Payload:** device id as string
        * **Source:** device
        
        ### State topic
        * **Topic name:** /state/<device_id>
        * **Payload:** device state
        * **Source:** device
        
        ### Event topic
        * **Topic name:** /event/<device_id>
        * **Payload:** an event
        * **Source:** device
        
        ### Config topic
        * **Topic name:** /config/<device_id>
        * **Payload:** configuration 
        * **Source:** gateway
        
        ### Commands topic
        * **Topic name:** /commands/<device_id>
        * **Payload:** command 
        * **Source:** gateway
        
        ## Interface I2
        
        Interface between Gateway and Bridge
        
        Protocol: MQTT
        
        ### Event topic
        * **Topic name:** /devices/<device_id>/events
        * **Payload:** event
        * **Source:** gateway
        
        ### State topic
        * **Topic name:** /devices/<device_id>/state
        * **Payload:** state
        * **Source:** gateway
        
        ### Config topic
        * **Topic name:** /devices/<device_id>/config
        * **Payload:** configuration
        * **Source:** IoT platform
        
        ### Commands topic
        * **Topic name:** /devices/<device_id>/commands/#
        * **Payload:** command
        * **Source:** IoT platform
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Requires-Python: >=3
Description-Content-Type: text/markdown
