Skip to content

Latest commit

 

History

History
105 lines (59 loc) · 4.59 KB

README.md

File metadata and controls

105 lines (59 loc) · 4.59 KB
Raw

(Links will open in this window. Shift+click, command+click, or middle mouse click to open in new window or tab.)

AVR-IoT Quick Start

This repository contains resources for quickly connecting your AVR-IoT device to your own Google Project and deploying a live UI to Firebase. It assumes you have already configured your device with Microchip's AVR START rapid development tool (coming soon).

Following this guide, you will clone this repo into your Google Cloud project, and run a script that:

  • enables Cloud Functions, Cloud IoT Core, and Pub/Sub,
  • creates an avr-iot Pub/Sub topic,
  • creates an IoT registry (default name: AVR-IOT, configurable in the script),
  • adds your device's UID to the registry,
  • builds and deploys a Cloud Function to route Pub/Sub messages to your Firebase project, and
  • builds and deploys a UI to firebase.

After running the quickstart script, you'll need to add your device's secure pubkey to the device's entry in your IoT core registry.

1. Create a GCP and Firebase Projects

The quickstart requires that you have a Firebase project connected to a GCP project will billing enabled.

GCP Project

  1. Create (or select an existing) GCP project.

    GO TO THE MANAGE RESOURCES PAGE

  2. Enable billing for the project.

    LEARN HOW TO ENABLE BILLING

Firebase Project

  1. Launch the Firebase Console.

    GO TO FIREBASE CONSOLE

  2. Select 'Add project'.

  3. In the Project Name field, select the GCP project you created or selected above.

  4. Click 'Add Firebase'.

2. Clone this repo in Cloud shell

  1. Open Cloud Shell from your project.

  2. In the shell, run

git clone https://github.com/Leverege/microchip-avr-iot.git && cd microchip-avr-iot && bash setup.sh

to clone this repo, enter the newly created directory, and run the quickstart script.

3. Run the Quickstart Script

  1. At the prompt, enter your AVR-IoT device's UID. Your device's UID is the last portion of the url you see after launching CLICK-ME.HTM from the device.

  2. If you would like to customize your IOT Core registry name, you may do so at the IoT core registry name prompt.

    IoT core registry names must start with a letter, use only letters, numbers, hyphens, and the following characters:

     + . % _ ~

  3. The setup script will run for several minutes. The setup script will:

    • Enable Cloud Functions, IoT, and Pub Sub
    • Create an IoT Core registry called AVR-IOT and register your device
    • Install, build, and deploy Cloud Functions and the UI

4. Add your devices public key to your IoT Core Registry

  1. Make sure your device is connected to your computer via USB.

  2. Open your IoT Core registry management page, and select the AVR-IOT registry.

    OPEN IOT CORE REGISTRY MANAGEMENT

  3. Click on your device's UID in the list.

    Because registry entries must begin with a letter your device UID will be prefixed with a 'd'. To search for your device by uid, you must enter 'd<your_device_id>' in the search box.

  4. Click the Add public key button.

  5. Select 'Upload' under the input method, and ES256 (not ES256_X509) as the public key format. Then click the Browse button.

  6. In the upload window, navigate to the CURIOSITY drive, then select PUBKEY.TXT and click add to upload it.

View your live data!

And that's it! If you've edited your device with the AVR START rapid development tool, you should see live data flowing to your new Firebase app at <your-project-id>.firebaseapp.com/device/<your-device-uid>.