Refactoring the structure

Author: Jim Bennett

README.md

@@ -0,0 +1,111 @@
+import blinkt
+import os, asyncio
+from dotenv import load_dotenv
+from azure.iot.device.aio import IoTHubDeviceClient, ProvisioningDeviceClient
+from azure.iot.device import MethodResponse
+
+load_dotenv()
+
+id_scope = os.getenv('ID_SCOPE')
+device_id = os.getenv('DEVICE_ID')
+primary_key = os.getenv('PRIMARY_KEY')
+
+blinkt.set_brightness(1)
+
+def set_colour(colour):
+    r = '0x' + colour[0:2]
+    g = '0x' + colour[2:4]
+    b = '0x' + colour[4:6]
+
+    r_value = int(r, 0)
+    g_value = int(g, 0)
+    b_value = int(b, 0)
+
+    print('Updating color: r =', r_value, ', g =', g_value, ', b =', b_value)
+
+    blinkt.set_all(r_value, g_value, b_value)
+    blinkt.show()
+
+async def main():
+    # provision the device
+    async def register_device():
+        provisioning_device_client = ProvisioningDeviceClient.create_from_symmetric_key(
+            provisioning_host='global.azure-devices-provisioning.net',
+            registration_id=device_id,
+            id_scope=id_scope,
+            symmetric_key=primary_key,
+        )
+
+        return await provisioning_device_client.register()
+
+    results = await asyncio.gather(register_device())
+    registration_result = results[0]
+
+    # build the connection string
+    conn_str='HostName=' + registration_result.registration_state.assigned_hub + \
+                ';DeviceId=' + device_id + \
+                ';SharedAccessKey=' + primary_key
+
+    # The client object is used to interact with your Azure IoT Central.
+    device_client = IoTHubDeviceClient.create_from_connection_string(conn_str)
+
+    # connect the client.
+    print('Connecting')
+    await device_client.connect()
+    print('Connected')
+
+    # Get the current colour
+    twin = await device_client.get_twin()
+    print('Got twin: ', twin)
+
+    try:
+        desired_colour = twin['reported']['colour']
+        set_colour(desired_colour)
+    except Exception as ex:
+        print("Couldn't load twin,")
+
+    # listen for commands
+    async def command_listener(device_client):
+        while True:
+            method_request = await device_client.receive_method_request()
+
+            print('Call made to', method_request.name)
+
+            colour = method_request.payload
+            
+            print('payload', colour)
+
+            if isinstance(colour, dict):
+                colour = colour['colour']
+
+            print('payload', colour)
+
+            set_colour(colour)
+
+            payload = {'result': True, 'data': colour}
+            method_response = MethodResponse.create_from_method_request(
+                method_request, 200, payload
+            )
+            await device_client.send_method_response(method_response)
+
+            # Write the colour back as a property
+            await device_client.patch_twin_reported_properties({'colour':colour})
+
+    # async loop that controls the lights
+    async def main_loop():
+        global mode
+        while True:
+            await asyncio.sleep(1)
+
+    listeners = asyncio.gather(command_listener(device_client))
+
+    await main_loop()
+
+    # Cancel listening
+    listeners.cancel()
+
+    # Finally, disconnect
+    await device_client.disconnect()
+
+if __name__ == '__main__':
+    asyncio.run(main())

app/app-blinkt.py

@@ -1,5 +1,5 @@
 import unicornhat as uh
-import os, asyncio, threading, random, time
+import os, asyncio
 from dotenv import load_dotenv
 from azure.iot.device.aio import IoTHubDeviceClient, ProvisioningDeviceClient
 from azure.iot.device import MethodResponse

app/app.py app/app-unicornhat.py

@@ -0,0 +1,51 @@
+#!/bin/bash
+
+# Update all the things
+sudo apt-get update
+sudo apt-get -y upgrade
+
+# Install the blinkt stuff
+promptreboot="no"
+curl https://get.pimoroni.com/blinkt  | bash -s -- -y
+
+# Create a folder for the app
+mkdir ~/BusyLight
+
+# Get the IoT Central settings
+echo What is the IoT Central ID Scope?
+read id_scope
+
+echo What is the device ID?
+read device_id
+
+echo What is the primary key?
+read primary_key
+
+# Create the .emv file
+echo "ID_SCOPE=$id_scope" >> ~/BusyLight/.env
+echo "DEVICE_ID=$device_id" >> ~/BusyLight/.env
+echo "PRIMARY_KEY=$primary_key" >> ~/BusyLight/.env
+
+# DOwnload the app files
+echo Downloading files...
+
+curl -L -o ~/BusyLight/requirements.txt https://github.com/jimbobbennett/BusyLight/releases/download/v0.2/requirements-blinkt.txt
+curl -L -o ~/BusyLight/app.py https://github.com/jimbobbennett/BusyLight/releases/download/v0.2/app-blinkt.py
+
+# Install the Python requirements
+echo Installing requirements...
+
+sudo pip3 install -r ~/BusyLight/requirements.txt
+
+# Add the control to the crontab
+
+sudo crontab -l > cron.tmp
+echo @reboot /usr/bin/python3 /home/pi/BusyLight/app.py >> cron.tmp
+sudo crontab cron.tmp
+rm cron.tmp
+
+# Done, so reboot
+
+echo Rebooting...
+
+sudo reboot

app/install-blinkt.sh

@@ -29,8 +29,8 @@ echo "PRIMARY_KEY=$primary_key" >> ~/BusyLight/.env
 # DOwnload the app files
 echo Downloading files...
 
-curl -L -o ~/BusyLight/requirements.txt https://github.com/jimbobbennett/BusyLight/releases/download/v0.1/requirements.txt
-curl -L -o ~/BusyLight/app.py https://github.com/jimbobbennett/BusyLight/releases/download/v0.1/app.py
+curl -L -o ~/BusyLight/requirements.txt https://github.com/jimbobbennett/BusyLight/releases/download/v0.2/requirements-unicornhat.txt
+curl -L -o ~/BusyLight/app.py https://github.com/jimbobbennett/BusyLight/releases/download/v0.2/app-unicornhat.py
 
 # Install the Python requirements
 echo Installing requirements...

app/install.sh app/install-unicornhat.sh

@@ -0,0 +1,3 @@
+blinkt
+azure-iot-device
+python-dotenv

app/requirements-blinkt.txt

@@ -0,0 +1,129 @@
+# Control the lights from an Office 365 calendar
+
+The lights can be controlled from your Office365 calendar using an Azure Logic App. You can set the lights to red (`FF0000`) when a meeting starts, then back to green (`00FF00`) when your meeting ends.
+
+## Create the logic app
+
+1. Open the Azure Portal at [portal.azure.com](https://portal.azure.com/?WT.mc_id=busylight-github-jabenn)
+
+1. Log in if you need to using your Microsoft account. If you don't have an Azure account follow the [instructions above](https://github.com/jimbobbennett/BusyLight/tree/master#set-up-the-iot-central-app) to create one.
+
+1. Select **+ Create a resource**
+
+1. Search for `Logic App`, select it then select **Create**
+
+1. Select your Azure subscription
+
+1. For the *Resource group* select **Create new** and name the new resource group **BusyLight**
+
+    > Resource groups are logical groupings of Azure services, allowing you to manage all the services for a particular application or project together.
+
+1. Name the logic app `CalendarControl`
+
+1. Select the *location* closest to you
+
+1. Select **Review + create**, then **Create**
+
+The logic app will be created, and when it is ready select **Go to resource**
+
+## Create a trigger
+
+1. When you first open the Logic App it will take you to the designer. From the *Templates* section, select **Blank logic app**
+
+1. Search the connectors and triggers for `office 365 outlook` and select the **Office 365 Outlook** connector
+
+1. Select the **When an upcoming event is starting soon** trigger
+
+1. The designer will show the new trigger. Select **Sign In** and sign in with your Office 365 account.
+
+1. Select your calendar in the *Calendar Id* drop down
+
+    > If you have multiple calendars to check, you will need to create multiple Logic Apps.
+
+1. Leave the look ahead time at 15 minutes
+
+1. Set an appropriate interval to poll for new items. Depending on how far in advance meetings can added to your calendar you can choose a suitable interval, as you pay for each poll. I use 10 minutes as I don't get meetings appearing in my calendar with less notice than that.
+
+    > This value needs to be less than the look ahead time otherwise events might be missed
+
+### Wait till the event starts
+
+The trigger is fired when it sees an upcoming event, so the app needs to delay till the event actually starts before changing the light to red. Logic app triggers and actions can pass data between them, so the Office 365 connector can pass the start and end times to the next action in the app.
+
+There is a small snag however - date and time formats are hard! The date format passed from the Office connector is not quite right for the one expected by the delay actions, so needs to be adjusted.
+
+1. Select **+ New step**
+
+1. Search for `Schedule` and select **Schedule**
+
+1. Select the **Delay until** action
+
+1. Select the *Timestamp* value and a box should pop up allowing you to build an expression
+
+1. Select the **Expression** tab, then select **Concat**
+
+    ![Adding concat to the expression](../images/BuildExpression1.png)
+
+1. Select the **Dynamic content** tab and select **Start time**. If you can't see this, select **See more** from the top of the list.
+
+1. Select the expression, and add `, 'Z'` before the last bracket. The select **OK**.
+
+    ![Adding Z to the expression](../images/BuildExpression2.png)
+
+### Execute the IoT Central command to change the light color
+
+The delay will hold till the meeting is about to start, so the next step is to connect to IoT Central to execute the command. To do this, you will need the IoT Central application Id and device Id.
+
+1. Open your IoT Central app
+
+1. Select **Administration** from the left-hand menu
+
+1. Select **Your application** from the *Administration* menu
+
+1. Take a note of the *Application ID*
+
+1. Select **Devices** from the left-hand menu
+
+1. Take a note of the *Device Id* of your device
+
+Once you have this Id, you can create the connector
+
+1. Head back to your logic app
+
+1. Select **+ New step**
+
+1. Search for `Azure IoT Central`, then select **Azure IoT Central**
+
+1. Select the **Run a command** action
+
+1. Once the action appears, select **Sign in** and log in with your Azure account if required
+
+1. Drop down the *Application* box and select **Enter custom value**
+
+1. Enter in the Application ID you noted down earlier
+
+1. Drop down the *Device Template* and select `Busy Light (1.0.0)`
+
+1. Enter your device id in the *Device* box
+
+1. Drop down the *Command* and select `Update Colour`
+
+1. Drop down *Add a new parameter* and check the box next to **Colour**
+
+1. Set the value of *Colour* to be the colour you want when you are in a meeting, using a 6 character RGB hex string. For example, for red enter `FF0000`
+
+## Handle the event ending
+
+Repeat the two steps above to add another Delay Until and Run a Command action to the app. The second delay should use the *End time* instead of the *Start time*, and for the colour use the colour you want when you are not in a meeting, such as `00FF00` for green.
+
+## Save the logic app
+
+1. Select **Save** from the Logic App designer menu to save the Logic App and enable it.
+
+## Test the logic app
+
+Add an upcoming event to your calendar - far enough away that the poll will be run once. Your light will turn red when the event starts and green when it finishes.
+
+<hr>
+
+In this step you created an Azure Logic app to control the lights from your Office356 calendar. [Check out the other trigger options](./connect-logic-app.md).

app/requirements.txt app/requirements-unicornhat.txt

@@ -0,0 +1,55 @@
+# Configure IoT Central
+
+In the [previous step](./set-up-hardware.md), you put together the hardware based around a Raspberry Pi. In this step, you will set up Azure IoT Central to control the device.
+
+## What is Azure IoT Central
+
+My favorite IoT cloud service is [Azure IoT Central](https://azure.microsoft.com/services/iot-central/?WT.mc_id=busylight-github-jabenn). This is a software as a service (SaaS) platform that allows devices to send data to and be controlled from the cloud. I can use this to send commands to the device to change the color of the light. I can also use to cache the current color so that if the device resets, it can retain it's previous color setting.
+
+## Set up the IoT Central app
+
+1. Head to [aka.ms/BusyLightTemplate](https://aka.ms/BusyLightTemplate). This link is to a pre-configured application template that you can use to create the IoT Central application
+
+1. You may be prompted to sign in, so sign in with your Microsoft account. If you don't have one you can create one during this step. A Microsoft account can be created with an email address from any provider, it doesn't just have to be hotmail or outlook.
+
+1. Give the application a name and a URL. The URL will need to be globally unique across all IoT central apps so add something personal or leave the auto-generated name.
+
+1. Select a pricing plan. You can have a free plan for 7 days without an Azure account, or a standard plan using an Azure account. Every account has 2 devices for free, so as long as you are only using 1 or 2 devices then you will never have to pay.
+
+    You will need an Azure subscription for a later step, and you can sign up for free:
+
+    * If you are a student aged 18 and up and have an email address from an academic institution, you can sign up for the free Azure for Students offer at [azure.microsoft.com/free/students](https://azure.microsoft.com/free/students/?WT.mc_id=busylight-github-jabenn) without a credit card. At the time of writing this gives you $100 of credit to use over 12 months, as well as free tiers of a number of services for that 2 months. At the end of the 12 months, if you are still a student you can renew and get another $100 in credit and 12 months of free services.
+
+    * If you are not a student, you can sign up at [azure.microsoft.com/free](https://azure.microsoft.com/free/?WT.mc_id=busylight-github-jabenn). You will need a credit card for verification purposes only, you will not be billed unless you decide to upgrade your account to a paid offering. At the time of writing the free account will give you US$200 of free credit to spend on what you like in the first 30 days, 12 months of free services, plus a load of services that have tiers that are always free.
+
+    If you go with a standard plan, select your *Directory*, *Azure subscription* and the *Location* nearest to you.
+
+    If you go with the free plan, enter your contact information.
+
+1. Select **Create**
+
+The IoT Central app will be provisioned and the dashboard will be loaded.
+
+## Create a device
+
+The app that is created contains everything you need to get going - except a configured device. From this app you can configure one or more devices and control these.
+
+1. Select **Devices** from the left-hand menu
+
+1. Select *Busy Light* from the **Devices** list
+
+1. Select **+ New** from the top menu
+
+1. Give the device a name and an Id, then select **Create**
+
+1. Select the newly created device, then select **Connect** from the top menu. This will show some connection values.
+
+1. Take a note of the *ID scope*, *Device ID* and *Primary key*
+
+    ![The connection dialog](../images/ConnectionDialog.png)
+
+Repeat this for as many devices as you want to control.
+
+<hr>
+
+In this step you set up Azure IoT Central to control the device. In the [next step](./install-pi-software.md) you will install the software on the Pi.