Пройдя данный codelab, вы научитесь основам программирования Arduino подобных микроконтроллеров и поймете, как использовать связку WioLink+Firebase для быстрого прототипирования IoT решений. Нас ждет увлекательная работа – соединение электронных компонентов, программирование микроконтроллера, подключение/настройка Firebase и разработка веб-страницы!
Для прохождения codelab вам понадобится ноутбук с MacOS (10.11+) или Windows (7+) и следующие хардварные компоненты:
- Обычное офисное кресло или офисный стул.
- Плата WioLink (в комплекте с кабелем USB-microUSB).
- Grove Led Bar v2.0 (в комплекте с кабелем Grove).
- Grove Ultrasonic Ranger (в комплекте с кабелем Grove).
- Моток изоленты, лучше всего синей!
Офисное кресло является предметом, с которым человек взаимодействует гигантсткое количество времени. При этом в современном мире стремительного развития «Интернета вещей» наши офисные кресла по-прежнему остаются «глупыми». Алексей Коровянский и Евгений Комаров решили это исправить и в рамках Mobilatorium-а сделали прототип IoT-решения умного офисного кресла. Этот эксперимент лег в основу нашего codelab-а.
Ключевой особенностью умного офисного кресла является отображение «состояния здоровья» пользователя. Для этого используется LED Bar и простая аналогия с зарядом батарейки телефона. Если пользователь сидит на кресле, то «уровень здоровья» уменьшается, разряжаясь полностью за N минут. Если пользователь встал с кресла, то «здоровье» начинает увеличиваться, заряжаясь полностью за M минут.
Читая дальнейший текст README и выполняя предложенные ЗАДАЧИ, вы шаг за шагом реализуете:
- Пару разминочных задачек по работе с Arduino.
- Программно-аппаратное решение для умного кресла.
- Умное кресло взаимодействующее с Firebase.
- Умное кресло взаимодействующее с веб-страницей.
Если вы прежде не работали с Arduino или Firebase — не волнуйтесь, мы начнем с самых простых вещей и будем очень плавно двигаться вперед, более того вы в первую секунду почувствуете, что WioLink и Firebase являются очень простыми и мощными средствами.
Codelab рассчитан на 60-90 минут. Если вы справитесь быстрее, мы будем рады увидеть ваши предложения по дальнейшему развитию идеи умного офисного кресла. Пара идей, которые у нас уже есть:
- Если пользователь очень долго сидит в «красной» зоне (когда уровень здоровья равен нулю), мы можем автоматически отправить SOS-сообщение его другу/коллеге о необходимости помочь другу передохнуть и размяться.
- Считать среднюю недельную статистику для команды (если вся команда использует умные офисные кресла) — готовы поспорить, что статистика большинства команд будет за пределами «зеленой зоны» (обозначающий здоровый график перерывов и разминок). Выход из «красной» или «желтой» зоны в «зеленую» это отличный челендж для любой команды, которая заботится о здоровье.
Ждем ваших креативных идей (issue с меткой enhancement), а еще лучше fork-ов и pull request-ов!
Итак, давайте приступим к работе!
Первым делом нам нужно установить драйвер для работы с WioLink.
Дальше нам понадобится PlatformIO, кроссплатформенная IDE на базе текстового редактора Atom, позволяющая программировать под большое количество микроконтроллеров. После установки и запуска PlatformIO необходимо создать новый проект (меню PlatformIO > Initialize or Update PlatformIO Project). В диалоге создания проекта необходимо указать тип платы микроконтроллера и путь, по которому будет размещаться наш проект. WioLink основана на процессоре ESP8266, поэтому среди предложенного перечня плат нам подойдет Espressif ESP8266 ESP-12E. После нажатия кнопки Process PlatformIO скачает все необходимые файлы для работы с нашим микропроцессором.
Помимо служебных файлов во вновь созданном проекте будет содержаться папки lib и src. Папка lib является хранилищем библиотек, подключенных к этому проекту, а папка src предназначена для кода проекта. Точками входа в Arduino приложение выступают функции void setup (разовый запуск настроек) и void loop (бесконечный цикл логики программы). Компилятор ищет эти функции во всех файлах в директории src.
Например, мы можем создать файл main.cpp в папке src, подключить библиотеку <Arduino.h> и объявить функции setup и loop следующим образом:
#include <Arduino.h>
void setup() {
// инициализация Serial порта c baudrate равным 28800
Serial.begin(28800);
// Для включения GPIO портов на плате WioLink необходимо подать высокий сигнал на 15-ый пин микропроцессора.
pinMode(15, OUTPUT);
digitalWrite(15, HIGH);
}
void loop() {
Serial.println("Hello World! Devfest Siberia 2016 rulezzzz");
delay(1000);
}
Для того, чтобы запустить данную программу на микроконтроллере, нужно подключить его к компьютеру с помощью кабеля USB-microUSB и залить прошивку на контроллер (с помощью меню PlatformIO > Upload или соответствующей кнопки на тулбаре).
Для отображения информации с последовательного порта в PlatformIO необходимо включить монитор последовательного порта из меню PlatformIO > Serial Monitor, указав baudrate (в нашем случае 28800) и соответствующий порт (в нашем случае CP2102 USB to UART Bridge controller).
ЗАДАЧА 1.1: Реализовать программу, выводящую на консоль "Devfest Siberia 2016 rulezzzz" ~ раз в 1000 миллисекунд. Если вы справились с этой задачей, значит вы корректно настроили окружение и готовы двигаться вперед к реализации нашего умного кресла!
Заметка: Периодически при работе с WioLink после прошивки плата «зависает». В этом случае помогает нажатие кнопки reset, расположенной на WioLink. Если ваша программа делает вид, что работает, но ничего не выводит на консоль, значит плата зависла, и вам нужно нажать кнопку reset.
Заметка: Вы узнали старый добрый синтаксис? Да, наша программа написана на C++. При этом в Arduino сообществе нет четко определенного code style, и каждый пишет как умеет. Вы еще успеете посетовать на это, подключая сторонние библиотеки в Шаге 2. А пока настройтесь писать несовершенный код, это же codelab!
На WioLink размещены 6 Grove совместимых разъемов. Из них 3 цифровых (Digital), 1 аналоговый (Analog), 1 UART и 1 I2C. Рядом с разъемами подписаны пины контроллера, подключенные к этим разъемам, а также пины к которым подключены питание (3v3) и земля (GND). Например, разъем Digital 0 включает в себя 14-й и 12-й пины, питание и землю.
Для отображения «уровня здоровья» мы будем использовать Grove LED Bar. Этот элемент имеет четыре пина: два сигнальных пина (DCKI и DI), пин VCC для подключения питания (поддерживается работа в диапазоне 3.3V - 5V) и пин GND для подключения земли. Как и любой другой Grove совместимый элемент наш Led Bar легко и надежно подключается к плате с помощью Grove кабеля. Если вы воткнете Led в разъем Digital 1, то dcki займет 13 пин контроллера, а di займет 12-ый.
Для взаимодействия с LED Bar мы рекомендуем использовать библиотеку https://github.com/Seeed-Studio/Grove_LED_Bar. Нужно скачать репозиторий библиотеки, распаковать архив и полученную папку перенести в lib нашего проекта.
Подключение библиотеки осуществляется строкой #include <Grove_LED_Bar.h>. После этого мы можем создавать объект класса Grove_LED_Bar с помощью конструктора Grove_LED_Bar(pinDcki, pinDi, direction), где pinDclk, pinDi - номера соответствующих сигнальных пинов, direction - направление загорания диодов (0 - прямое, 1 - обратное). Также в функции setup у объекта Grove_LED_Bar необходимо вызывать метод begin().
Для управления LED Bar-ом рекомендуется использовать метод setLevel (float level). Значение level может варьироваться от 0 до 10, включая дробные значения. В зависимости от выбранного level будет включаться соответственное количество диодов (от 0 до 10). В случае если указано дробное число, будет меняться яркость свечения последнего диода.
ЗАДАЧА 2.1: Реализовать схему, которая на старте зажигает все десять индикаторов LED Bar-а и дальше постепенно гасит все индикаторы.
Заметка: Для перезапуска программы можно использовать кнопку Reset.
Теперь мы можем перейти к реализации бизенс-логики нашего умного кресла. Зарядка и разрядка «здоровья» должна осуществляться за счет определения, сидим мы сейчас на стуле или нет. Для этого нам понадобится ультразвуковой дальномер Grove Ultrasonic Ranger. Этот датчик имеет три функциональных пина: цифровой сигнальный пин (SIG), пин VCC для подключения питания (поддерживается работа в диапазоне 3.3V - 5V) и пин GND для подключения земли. Оставшийся пин (NC) Groove разъема не используется.
Для взаимодействия с Ultrasonic Ranger мы рекомендуем использовать библиотеку https://github.com/Seeed-Studio/Grove_Ultrasonic_Ranger. Подключение осуществляется строкой #include <Ultrasonic.h>, после этого мы можем создать объект класса Ultrasonic с помощью конструктора Ultrasonic(pinUltrasonicRangeFinder) и измерять расстояние методом MeasureInCentimeters().
ЗАДАЧА 2.2: Реализовать схему умного офисного кресла. Когда мы сидим на кресле, «уровень здоровья» должен уменьшаться, разряжаясь полностью за 60 секунд. Если мы встали с кресла, то «здоровье» должно увеличиваться, заряжаясь полностью за 20 секунд. Схема должна быть собрана на реальном стуле и работать в боевых условиях. Для крепления датчиков и платы используйте синюю изоленту.
Когда вы получите работающую версию, поаплодируйте себе, ведь теперь вы знаете, как легко и просто собирать умные контроллеры!
У нас уже есть умное офисное кресло, но оно еще не подключено к возможностям "Интернета вещей". Для того, чтобы это исправить, нам нужно научиться подключать нашу плату к WiFi сети.
Плата WioLink имеет встроенный WiFi модуль, для работы с ним нам потребуется добавить библиотеку ESP8266WiFi к проекту. Эта библиотека загрузилась PlatformIO вместе с инструментарием для разработки под esp8266. Она является глобальной, поэтому достаточно просто подключить ее строкой #include <ESP8266WiFi.h>.
WiFi инициализируется с помощью статического метода WiFi.begin(WIFI_SSID, WIFI_PASSWORD) для подключения к закрытой сети или метода WiFi.begin(WIFI_SSID) для работы с открытой сетью. Подключение происходит асинхронно. Для проверки успешности подключения необходимо использовать сравнение вида WiFi.status() == WL_CONNECTED.
ЗАДАЧА 3.1: Подключить наше умное кресло к доступной сети WiFi.
Теперь наша плата подключается к WiFi и Интернету, что открывает перед нами бесконечный простор для творчества. Следующим шагом нам нужно научиться сохранять в Cloud текущее значение «здоровья», и перенести туда же управление параметрами разрядки и зарядки.
В качестве облачного хранилища мы будем использовать Firebase Realtime Database, как бесплатный и простой NoSQL Сloud Storage, отлично подходящий для быстрого прототипирования пользовательских IoT решений.
Для взаимодействия между WioLink и Firebase базой данных мы будем использовать библиотеку https://github.com/googlesamples/firebase-arduino. Подключение осуществляется строкой #include <FirebaseArduino.h>. Инициализирование Firebase происходит с помощью вызова статического метода Firebase.begin(FIREBASE_HOST, FIREBASE_AUTH).
FIREBASE_HOST можно посмотреть на странице Firebase Admin SDK (шестеренка рядом с названием проекта > Project Settings > Service Accounts > Firebase Admin SDK > databaseURL, необходимо скопировать строку без https://). FIREBASE_AUTH можно найти в Database Secrets (шестеренка рядом с названием проекта > Project Settings > Service Accounts > Database Secrets).
После успешной инициализации Firebase клиента мы можем работать с БД. Метод Firebase.getInt(name) позволяет читать целые значения, а метод Firebase.setFloat(name, value) позволяет записывать вещественные значения.
ЗАДАЧА 3.2: Создать новый Firebase проект. В базе данных создать три поля: health с произвольным вещественным значением, time_to_discharge равную 10-ти секундам и time_to_recharge равную 1-й секунде. После этого обновить логику программы так, чтобы значение параметров time_to_discharge и time_to_recharge динамически считывалось из Firebase и применялось к работе нашего приложения, а значение «здоровья» в режиме реального времени сохранялось в Firebase в поле health. В случае получения новых значений параметров (time_to_discharge или time_to_recharge) состояние кресла должно перезагружаться — «здоровье» сбрасываться в максимум, а дальнейшее поведение «на лету» подстраиваться под обновленные значения.
Заметка: При сборке проекта с этой библиотекой компилятор будет ругаться на отсутствие файлов ESP8266HTTPClient.h и ESP8266WebServer. Причина в том, что Platform IO добавляет на этапе прекомпиляции только те библиотеки, на которые есть прямые ссылки из файлов из папки src. Поэтому достаточно добавить #include <ESP8266HTTPClient.h> и #include <ESP8266WebServer.h> до подключения библиотеки FirebaseArduino.
Заметка: Если предыдущий вызванный Firebase метод завершился с ошибкой, метод Firebase.failed() - вернет true, в противном случае false. String переменную с описание ошибки можно получить вызовом метода Firebase.error().
Получилось?! А сколько перерывов и разминок вы сделали за время работы? Если ноль, то встаньте и разомнитесь прямо сейчас!
Поздравляем! Вы освоили базовые техники работы с IoT и Firebase!
Теперь давайте добавим вишенку на торте и сделаем веб-страницу, отображающую «уровень здоровья». Для этого нам нужно сделать три шага — сверстать страницу, обновить настройки Firebase приложения и реализовать взаимодействие с Firebase средствами Javascript.
С целью экономия времени вы можете ускорить первый шаг и взять готовую верстку страницы. В ней нас интересует кастомный UI компонет для отображения «уровня здоровья». Для установки его значения используйте:
document.getElementById('health-bar').style.height = progress + '%'; // progress от 0 до 100Для взаимодействия между веб-страницей и Firebase нам потребуется обновить настройки Firebase проекта. В разделе Database > Rules, нужно установить значение true для поля .read. Это позволит нам успешно считывать «уровень здоровья» и отображать его на веб-странице.
Теперь нам нужно оживить нашу верстку и отображать корректное значение «уровня здоровья» на веб-страницу. Для этого нам нужно написать несколько строчек Javascript кода. Первым шагом нужно инициализировать Fireabase, для этого идем на главную страницу нашего Firebase проекта, там нажимаем кнопку "Add Firebase to your web app" и копируем предложенный листинг в начало нашего JS-скрипта.
Для отслеживания значения поля в Firebase базе данных нужно получить Reference объект и подписаться на его изменения следующим образом:
firebase.database().ref('health').on('value', function(snapshot) {
// этот callback будет вызываться каждый раз при изменении поля health
// для получения значения нужно вызвать snapshot.health
});ЗАДАЧА 4.1: Реализовать веб-страницу, отображающую «уровень здоровья» для нашего умного офисного кресла.
Заметка: Одним из преимуществ Firebase является то, что его можно легко подключить к всевозможным платформам и технологиям — Arduino, Android, iOS, Browser Javascript, Node.js, Unity и многим другим. Поэтому вы можете легко сделать красивое приложение для вашей любимой платформы.
Поздравляем с успешным прохождением codelab! Теперь вы знаете, как легко и просто можно создать собственное решение для умного дома (или офиса) с помощью WioLink/Arduino и Firebase. Будем рады видеть ваш вклад в развитие нашего эксперимента!
И приглашаем вас подписаться на ВК-страницу Mobilatorium-а, чтобы быть в курсе наших следующих экспериментов с IoT/AR/VR.