provisiondevices.py

# ==================================================================================
#   File:   provisiondevices.py
#   Author: Larry W Jordan Jr (larouex@gmail.com)
#   Use:    Raspberry Pi "Protocol Translation" Gateway for Azure IoT Central
#           This module provisions devices and updates the devicescache. 
#           It either re-provisions all devices or just those that have null in
#           LastProvisioned option in the file i.e "LastProvisioned": null
#
#   Online:   www.hackinmakin.com
#
#   (c) 2020 Larouex Software Design LLC
#   This code is licensed under MIT license (see LICENSE.txt for details)    
# ==================================================================================
import  getopt, sys, time, string, threading, asyncio, os
import logging as Log

# our classes
from classes.provisiondevices import ProvisionDevices
from classes.config import Config

# -------------------------------------------------------------------------------
#   Provision Devices
# -------------------------------------------------------------------------------
async def provision_devices(ProvisioningScope, GatewayType):

  provisiondevices = ProvisionDevices(Log, ProvisioningScope, GatewayType)
  await provisiondevices.provision_devices()
  return True

async def main(argv):

    # execution state from args
    provisioning_scope = None
    gateway_type = None

    short_options = "hvp:g:"
    long_options = ["help", "verbose", "provisioningscope=", "gatewaytype="]
    full_cmd_arguments = sys.argv
    argument_list = full_cmd_arguments[1:]
    try:
        arguments, values = getopt.getopt(argument_list, short_options, long_options)
    except getopt.error as err:
        print (str(err))
    
    for current_argument, current_value in arguments:
        if current_argument in ("-h", "--help"):
            print("HELP for provisiondevices.py")
            print("------------------------------------------------------------------------------------------------------------------")
            print("-h or --help - Print out this Help Information")
            print("-v or --verbose - Debug Mode with lots of Data will be Output to Assist with Debugging")
            print("-p or --provisioningscope - Provisioning Scope give you fine grained control over the devices you want to provision.")
            print("    ALL - Re-Provision Every device listed in the DevicesCache.json file")
            print("    NEW - Only Provision Devices DevicesCache.json file that have 'LastProvisioned=Null'")
            print("    device name - Provision a Specifc Device in DevicesCache.json file")
            print("-g or --gatewaytype - Indicate the Type of Gateway Relationship")
            print("    OPAQUE - Devices will look like Stand-Alone Devices in IoT Central")
            print("    TRANSPARENT - Devices will look like Stand-Alone Devices in IoT Central")
            print("    PROTOCOL - IoT Central will show a Single Gateway and all Data is Associated with the Gateway")
            print("    PROTOCOLWITHIDENTITY - IoT Central will show a Single Gateway and Leaf Devices")
            print("------------------------------------------------------------------------------------------------------------------")
            sys.exit()
        
        if current_argument in ("-v", "--verbose"):
            Log.basicConfig(format="%(levelname)s: %(message)s", level=Log.DEBUG)
            Log.info("Verbose mode...")
        else:
            Log.basicConfig(format="%(levelname)s: %(message)s")
        
        if current_argument in ("-p", "--provisioningscope"):
            Log.info("Provisioning Scope Override...%s" % current_value)
            provisioning_scope = current_value

        if current_argument in ("-g", "--gatewaytype"):
            Log.info("Gateway Type  Override...%s" % current_value)
            gateway_type = current_value

    # Load Configuration File
    config = Config(Log)
    config_data = config.data
    
    if provisioning_scope == None:
      provisioning_scope = config_data["ProvisioningScope"]

    if gateway_type == None:
      gateway_type = config_data["GatewayType"]

    await provision_devices(ProvisioningScope=provisioning_scope, GatewayType=gateway_type)

if __name__ == "__main__":
    asyncio.run(main(sys.argv[1:]))