Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 2.68 KB

Getting Started With Arduino.md

File metadata and controls

42 lines (26 loc) · 2.68 KB
Raw

Getting started with Arduino firmware

To create firmware to upload to your OpenHAK, you'll need to install the correct board files into the Arduino IDE

  1. Open the Arduino IDE

  2. On a Mac, click on the Arduino menu and select preferences, on PC and Linux, select the File menu and select preferences

  3. Find the Additional Boards Managers URLs: box and click the icon to the right of it

  4. On a new line, paste the OpenHAK boards json:

    https://raw.githubusercontent.com/OpenHAK/Simblee/master/package_openhak_index.json

  5. Click OK

  6. Now click the tools menu, mouse over the Board: option, then select Boards manager

  7. This list should take a moment to refresh and then you'll be able to scroll down until you see the OpenHAK boards listed, or just type OpenHAK in the search filed.

  8. Click the instal button and wait for the instal to complete

  9. Now you can select the OpenHAK board from the Arduino Boards menu, and compile code for your OpenHAK!

Getting code onto your OpenHAK

The easiest way, that also requires no additional hardware, is to use the OTA DFU method. Find videos and a step by step guide here. The guide shows you how to upload new firmware Over The Air (wirelessly) and uses our latest production release in the example.

If you want to modify or make your own code

You can do it in the Arduino IDE.

Always include the OTA bootloader library #include <ota_bootloader.h> to make sure that you can keep using OTA firmware update.

The trick to using the OTA method of firmware update is that it requires a specially formatted ZIP file. You'll be happy to know that our OpenHAK board files that you just loaded into Arduino above already make this possible. Instead of pressing the Upload button, go to

Sketch / Export compiled Binary

When you click on that, the Arduino IDE will compile your code (if it can) and the spit out a ZIP file into the same sketch folder as your code. The ZIP file will be titled something like OpenHAK_Firmware_v01.ino.zip Remember to take out the .ino in the file name as this can cause hiccups. Now all you have to do is get that ZIP file onto your phone and follow the guide on using OTA tools.

Other Stuff

If you program code OTA but fail to include the OTA bootlader library, you will need a 3.3v FTDI and an OpenHAK accessory cable to re-flash the board. Please, always #include <ota_bootloader.h>!

  • insert pic of hardware pinout with specs and links to male header
  • if using SparkFun library comment out line 147 and another one...
    • _i2cPort->setClock(i2cSpeed);