Skip to content

Open Source Internet Of Things Rapid Prototyping Framework For Environmental Sensing Applications

Notifications You must be signed in to change notification settings

OPEnSLab-OSU/Loom-V4

Repository files navigation

logo

Loom Version 4

An Internet of Things Rapid Prototyping System for applications in environmental sensing
Documentation · Project Wiki · Quick Start

Table of Contents


Introduction

This version takes a step back and removes a lot of the aspects that make Loom 3 very hard to work with. This results in a more open and easy to work with framework that allows user to choose to use Loom and its features, or simply use the reliable software written for these sensors without the loom overarch.

Install

The install process is fairly simple:

Install Arduino

  • Download and install the latest version of the Arduino IDE

  • NOTE: If installing on Windows, download the Windows Installer

  • NOTE: If installing on Linux, see the official Linux install guide

Install Board Profiles

  1. Open Arduino IDE
  2. Once Open Click File > Preferences or Ctrl + ,
  3. In the text box labeled "Additional Boards Manager URLs" paste this text into the box https://adafruit.github.io/arduino-board-index/package_adafruit_index.json,https://raw.githubusercontent.com/OPEnSLab-OSU/Loom-V4/main/auxilary/package_loom4_index.json
  4. Press Ok
  5. Next click Tools > Board > Boards Manager
  6. Search and install the following Board Profiles
    • Arduino SAMD Boards
    • Adafruit SAMD Boards
    • Loom SAMD Boards V4
  7. Install the latest version of all three boards as they appear

If you use Mac:

Give Arduino IDE Full Disk Access: System Preferences->Security & Privacy->"Privacy" tab->Full Disk Access->+ plus button to add Arduino You will also need to install Developet Tools, which requires Admin access.

Getting Started Resources

  1. Loom Manager Walkthrough: https://media.oregonstate.edu/media/t/1_csq6zrae
  2. Loom Hypnos Walkthrough: https://media.oregonstate.edu/media/t/1_7owroc4a
  3. Hypnos Interrupts: https://media.oregonstate.edu/media/t/1_7hq18o2d
  4. C++ Tutorials https://www.cprogramming.com/tutorial/c++-tutorial.html?inl=nv
  5. Loom Sensor Hookup Tutorials: https://www.youtube.com/watch?v=AU5vwO4RJqE&list=PLGLI7V_o5-ahvLrscgoZRVfLx5KtgjEVV&index=3
  6. How to use Git: https://youtu.be/jRJ6Aklc4iQ
  7. Loom Logger: https://youtu.be/O3mnjWIp8MI
  8. I2C and I2C: https://youtu.be/TrAzs9ex4kE

Run an Example

Select Board

  • Make sure in the Tools > Board menu, that "Loomified Feather M0" is selected
    • If that board is not present, make sure you followed all the instructions above in Installation
    • Plug in your Feather board and then make sure in the Tools > Port menu that you select the device with "Adafruit Feather M0" in the name.

Compile

  • Start by compiling our Basic Loom examples (File > Examples > Loom > Sensors > Analog) to ensure that it compiles. If not, review the previous steps.
    • Once the Basic example is open, click the checkbox icon "Verify" in the top. (This may take several minutes to compile, this is to be expected)
    • You should get white-color font text readout mentioning a successful compilation and x% memory used. Successful compilation message
    • Note: may disregard orange-color warning text regarding nRF

Troubleshooting

If you get permissions error accessing the library folder, and are using a Mac, see note in the installation section above. If you are updating from an old version of Loom, you may need to do a "clean install" by removing the Arduino15 folder, and starting the process from the beginning to install again.

Best Practices

Will Fill in Please.

Issues

If you are experiencing issues, please click the "Issues" tab on this repo and choose the template that best fits your needs. Please supply as much information as possible. This helps us to better understand a fix issues quickly

Weird Feather M0 Issues

There are some weird idiosyncrasies with the Feather M0

  • Something that is only found in the datasheet is that pin A7 and pin D9 are linked together and since A7 is the voltage divider this pin sits at around 2v at all times

  • Some interrupt vectors are linked together so multiple pins may use the same interrupt and may then break interrupts below is a list of pins and their corresponding interrupt

    Pin # Interrupt #
    D11 0
    D13 1
    D10, A0, A5 2
    D12 3
    D6, A3 4
    A4 5
    SDA 6
    D9, SCL 7
    A1 8
    A2 9
    D23, D1 10
    D24, D0 11
    D5 15
  • LoRa Must Be Configured Properly based off the selected modem configuration, see issue: #54

  • Please DO NOT use the Arduino String library, if at all possible it fragments the crap out of the memory and makes devices crash. I spent ~40 hours or so porting the entire library to C-strings - Will

OPEnS Supported Projects

  • WeatherChimes (Stable ✅)
  • Lily Pad (Stable ✅)
  • FloDar (Stable ✅)
  • Smart Rock (Stable ✅)
  • Evaporometer (Stable ✅)
  • Dendrometer (Stable ✅)