Difference between revisions of "Mihini/EclipseCon2013 Tutorial"

From Eclipsepedia

Jump to: navigation, search
(Installation of Lua Development Tools (all-in-one bundle))
(Get SDcard image used during the tutorial)
(36 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= Tutorial =
+
= Tutorial =
EclipseCon 2013 Tutorial plan.
+
  
== Goals ==
+
This tutorial "'''Develop a complete M2M application with Koneki and Mihini'''" occurred at EclipseCon 2013 on 2013-03-25.
  
=== Show Mihini ===
+
== Tutorial material ==
* show key APIs such as logging, sched, airvantage, devicetree, (sms?)...
+
* show how it's easy to do I/O manipulation and wireless communication
+
  
=== Koneki for Mihini ===
+
Tutorial material is hosted at https://github.com/SierraWireless/eclipsecon2013-m2m-tutorial
* show how Lua is easy to edit thanks to LDT tooling
+
* show EE and remote development for Mihini
+
  
=== FUN!!!!!! ===
+
How to get it:
  
== Key steps ==
+
*Clone git repository
 +
    git clone https://github.com/SierraWireless/eclipsecon2013-m2m-tutorial.git
 +
    # to get the beautiful and correct look&feel for the slides
 +
    git submodule update --init
  
=== Introduction to the greenhouse demo ===
+
*download zip file:
  
{{Note|TODO| slides ?}}
+
https://github.com/SierraWireless/eclipsecon2013-m2m-tutorial/archive/master.zip
  
=== Introduction to Mihini ===
+
Once you've got the repo locally, you can browse tutorial material:
  
{{Note|TODO| slides ?}}
+
Especially:
  
==== Features ====
+
*'''slides''':&nbsp;at the root of the repo <br>index.html&nbsp;
  
{{Note|TODO| slides ?}}
+
*'''Code Solution''':<br>lab/mihini-tutorial-step3/
  
==== Overall architecture ====
+
(That's a Koneki project, so can import it directly in your IDE)
  
{{Note|TODO| slides ?}}
+
<br>
  
=== Introduction to Koneki tools for Mihini ===
+
== Goals  ==
  
{{Note|TODO| slides ?}}
+
=== Show Mihini  ===
  
=== Installation of Lua Development Tools (all-in-one bundle) ===
+
*show key APIs such as logging, sched, airvantage, devicetree, (sms?)...
 +
*show how it's easy to do I/O manipulation and wireless communication
  
Note: Koneki doc for remote system [http://wiki.eclipse.org/Koneki/LDT/Developer_Area/User_Guides/User_Guide_0.9#Remote_session http://wiki.eclipse.org/Koneki/LDT/Developer_Area/User_Guides/User_Guide_0.9#Remote_session]
+
=== Koneki for Mihini  ===
  
{{Note|TODO| instructions ?}}
+
*show how Lua is easy to edit thanks to LDT tooling
 +
*show EE and remote development for Mihini
  
==== Write and run a local LUA example ====
+
=== FUN!!!!!!  ===
  
{{Note|TODO| instructions ?}}
 
  
==== Configure remote system ====
 
  
{{Note|TODO| instructions ?}}
+
== Hardware  ==
  
==== Remote launch the previous example ====
+
The main hardware will be a Raspberry Pi (running Mihini) connected to an Arduino&nbsp;; the Arduino itself being connected to several sensors/actuators.
  
{{Note|TODO| instructions ?}}
+
==== Bill of materials  ====
  
=== Local communication ===
+
This is the minimal list of materials to reproduce the demo:
  
{{Note|TODO| slides ?}}
+
{| border="1" cellspacing="0"
 +
|-
 +
! Item
 +
! Qty
 +
|-
 +
| Raspberry Pi
 +
| 1x
 +
|-
 +
| Arduino Uno
 +
| 1x
 +
|-
 +
| Grove kit or equivalent
 +
| 1x
 +
|-
 +
| Micro USB cable
 +
| 1x
 +
|-
 +
| 4GB SD card
 +
| 1x
 +
|-
 +
| USB 1A power supply
 +
| 1x
 +
|-
 +
| USB A-B cable
 +
| 1x
 +
|-
 +
| Wifi dongle (Netgear WNA1000M-100FRS)*
 +
| 1x
 +
|-
 +
| Breadboard
 +
| 1x
 +
|-
 +
| Temperature Sensor (LM35DZ)
 +
| 1x
 +
|-
 +
| Luminosity Sensor (CdS Photoconductive Photocell, like PDV-P8001)
 +
| 1x
 +
|-
 +
| LED
 +
| 1x
 +
|-
 +
| Resistor 1k
 +
| 1x
 +
|-
 +
| Resistor 10k
 +
| 1x
 +
|}
  
==== Modbus API ====
+
<br> You can ordering (almost) everything from Adafruit:
  
{{Note|TODO| slides ?}}
+
*Raspberry Pi: https://www.adafruit.com/products/998 - 39.95USD
 +
*Starter pack for Arduino: https://www.adafruit.com/products/68 - 65.00USD
 +
*Sensors (the ones provided in the budget pack)
 +
*SD card: https://www.adafruit.com/products/102 - 7.95USD
 +
*Power supply: https://www.adafruit.com/products/501 - 5.95USD
 +
*USB A-Micro: https://www.adafruit.com/products/592 - 3.95USD
 +
*USB A-B (the one provided in the budget pack)
 +
*WiFi dongle: https://www.adafruit.com/products/814 - 11.95USD
 +
*TOTAL: 135USD
  
=== Greenhouse tutorial ===
+
=== Schematics ===
  
{{Note|TODO| slides ?}}
+
[[Image:Mihini EclipseCon2013 Arduino Schematics bb.png]]
  
==== Read/write some values with modbus ====
 
  
{{Note|TODO| instructions ?}}
 
  
==== Install execution environment ====  
+
== Software parts to reproduce the tutorial  ==
  
{{Note|TODO| instructions ?}}
+
=== Running Mihini on RaspberryPi  ===
  
==== Create new Mihini project ====
+
==== Get SDcard image used during the tutorial  ====
  
{{Note|TODO| instructions ?}}
+
!!!!!Work in progress!!!!!
  
=== Introduction to push data ===
+
Get the image here:
  
{{Note|TODO| slides ?}}
+
    https://www.dropbox.com/s/ftrqfshi62h078t/eclipsecon-raspi-img.tgz
  
==== M3DA protocol ====
+
Follow the instructions there:
  
{{Note|TODO| slides : Julien}}
+
    http://elinux.org/RPi_Easy_SD_Card_Setup
  
==== push data API ====
+
Mihini version used:
 +
  commit b660318d51a113d58c1e7b7a1ffdac210f5e3352
  
{{Note|TODO| slides ?}}
+
==== Compile and run Mihini manually  ====
  
=== Add server communication to the code ===
+
Available instructions [[Mihini/Run Mihini on an Open Hardware platform|here]]
  
{{Note|TODO| instructions ?}}
+
<br>
  
==== push data ====
+
=== Installation of Lua Development Tools (all-in-one bundle)  ===
  
{{Note|TODO| instructions ?}}
+
Home of Koneki Lua Development Tools:
 +
http://eclipse.org/koneki/ldt/
  
==== m2m.eclipse.org ====
+
Default version of Koneki doesn't come with Remote Target Management feature (that enables, for this tutorial, to connect to RaspberryPi system, send your application to it etc).
  
{{Note|TODO| instructions/slides ?}}
+
To create the all-in-one bundle that was provided during the tutorial, you have to:
 +
TBD
  
==== JSon API for displaying data ====
 
  
{{Note|TODO| instructions/slides ?}}
+
=== Setting up the Arduino  ===
  
=== Go further ===
+
Arduino code used for the tutorial is --&gt;
  
{{Note|TODO| slides ?}}
+
https://github.com/kartben/mihini-greenhouse-demo/tree/master/SimpleModbusSlaveExample
  
==== App con ====
 
  
{{Note|TODO| slides ?}}
+
=== M3DA Server  ===
  
==== End user android application ====
+
An instance of M3DA server is running on Eclipse M2M machine.
  
{{Note|TODO| slides ?}}
+
To contact it with Mihini agent, you must use this address:
 +
    tcp://m2m.eclipse.org:44900
  
=== Installation of Lua Development Tools ===
+
Run you own M3DA server instance:
  
Download Lua Development Tools product (or get it from an USB stick provided to the participants), install the Remote Lua Development feature.
+
Everything you need for that is there (How to build, to run, interact with):
 +
    https://github.com/SierraWireless/m3da-server
  
{{Note|TODO|Retrieve and put LDT archives on USB stick}}
 
  
{{Note|TODO|Put LDT p2 repo on the USB stick too}}
+
=== End user Android application ===
 
+
 
+
==== Hello World ====
+
 
+
* Write a first simple Lua application ("Hello World").
+
* Get familiar with the notion of Execution Environment, learn how to use Lua.
+
* Launch the application using the embedded JNLua VM
+
* Learn how to use the debugger
+
 
+
=== Installation of Mihini ===
+
 
+
Participants will compile and install Mihini on the Raspberry Pi based on the instructions available [[Mihini/Run_Mihini_on_an_Open_Hardware_platform|here]]
+
 
+
==== Compile Mihini source code ====
+
 
+
* Copy (git clone?) the sources of Mihini on the Raspberry Pi
+
 
+
{{Note|TODO|Provide a copy of the git repo on the USB stick???}}
+
 
+
* Compile Mihini (and its Lua VM)
+
* Brief presentation of the defaultconfig ; tweak the few settings that will simplify development
+
 
+
==== First Mihini launch ====
+
 
+
* Start Mihini on the target
+
* Open a telnet connection on port 2000 to play with the agent's shell
+
** a = 1
+
** print(a)
+
** :agent.config.get('shell')
+
 
+
==== Hello World REMOTE ====
+
 
+
* Configure a new Remote System corresponding to the Raspberry Pi inside LDT
+
* Launch the previously written Hello World using a remote launch conf
+
* Do a remote debug
+
 
+
=== Setting up the Arduino ===
+
 
+
* First step will be to setup the arduino with a blinking LED
+
 
+
{{Note|TODO|Prepare Arduino IDE archives (mac, linux, win) for the USB stick}}
+
 
+
{{Note|TODO|Fritzing schematic of the blinking LED setup?}}
+
 
+
 
+
* Next is the instalation of the Modbus stack --> https://github.com/kartben/mihini-greenhouse-demo/tree/master/SimpleModbusSlaveExample
+
 
+
=== Remote run/debug ===
+
Log hello on the module.
+
 
+
 
+
 
+
=== Wireless code ===
+
Upload first data on internet using MQTT and AirVantage
+
 
+
=== Install application ===
+
Show how to install an application using mihini (and airVantage)
+
 
+
== Hardware ==
+
 
+
The main hardware will be a Raspberry Pi (running Mihini) connected to an Arduino ; the Arduino itself being connected to several sensors/actuators.
+
 
+
=== Bill of materials ===
+
 
+
{| border="1" cellspacing="0"
+
! Item        !! Qty
+
|-
+
| Raspberry Pi                                                          || 1x
+
|-
+
| Arduino Uno                                                          || 1x
+
|-
+
| Grove kit or equivalent                                                || 1x
+
|-
+
| Micro USB cable                                                || 1x
+
|-
+
| 4GB SD card                                                || 1x
+
|-
+
| USB 1A power supply                                                || 1x
+
|-
+
| USB A-B cable                                                || 1x
+
|-
+
| Wifi dongle (Netgear WNA1000M-100FRS)*                                                || 1x
+
|}
+
  
* this might not be the best option for the US market (sounds look it is way more expensive than in Europe?)
+
Get it there:
 +
http://git.eclipse.org/c/mihini/org.eclipse.mihini.samples.git/tree/greenhouse/corona-greenhouse-demo
  
 +
== Develop the Lua Application ==
  
Ordering everything from Adafruit would be:
+
See the slides and code solution in [[#Tutorial material]]!!
* Raspberry Pi: https://www.adafruit.com/products/998 - 39.95USD
+
* Starter pack for Arduino: https://www.adafruit.com/products/68 - 65.00USD
+
* Sensors (the ones provided in the budget pack)
+
* SD card: https://www.adafruit.com/products/102 - 7.95USD
+
* Power supply: https://www.adafruit.com/products/501 - 5.95USD
+
* USB A-Micro: https://www.adafruit.com/products/592 - 3.95USD
+
* USB A-B (the one provided in the budget pack)
+
* WiFi dongle: https://www.adafruit.com/products/814 - 11.95USD
+
* TOTAL: 135USD
+

Revision as of 12:42, 3 April 2013

Contents

Tutorial

This tutorial "Develop a complete M2M application with Koneki and Mihini" occurred at EclipseCon 2013 on 2013-03-25.

Tutorial material

Tutorial material is hosted at https://github.com/SierraWireless/eclipsecon2013-m2m-tutorial

How to get it:

  • Clone git repository
   git clone https://github.com/SierraWireless/eclipsecon2013-m2m-tutorial.git
   # to get the beautiful and correct look&feel for the slides
   git submodule update --init
  • download zip file:
https://github.com/SierraWireless/eclipsecon2013-m2m-tutorial/archive/master.zip

Once you've got the repo locally, you can browse tutorial material:

Especially:

  • slides: at the root of the repo
    index.html 
  • Code Solution:
    lab/mihini-tutorial-step3/

(That's a Koneki project, so can import it directly in your IDE)


Goals

Show Mihini

  • show key APIs such as logging, sched, airvantage, devicetree, (sms?)...
  • show how it's easy to do I/O manipulation and wireless communication

Koneki for Mihini

  • show how Lua is easy to edit thanks to LDT tooling
  • show EE and remote development for Mihini

FUN!!!!!!

Hardware

The main hardware will be a Raspberry Pi (running Mihini) connected to an Arduino ; the Arduino itself being connected to several sensors/actuators.

Bill of materials

This is the minimal list of materials to reproduce the demo:

Item Qty
Raspberry Pi 1x
Arduino Uno 1x
Grove kit or equivalent 1x
Micro USB cable 1x
4GB SD card 1x
USB 1A power supply 1x
USB A-B cable 1x
Wifi dongle (Netgear WNA1000M-100FRS)* 1x
Breadboard 1x
Temperature Sensor (LM35DZ) 1x
Luminosity Sensor (CdS Photoconductive Photocell, like PDV-P8001) 1x
LED 1x
Resistor 1k 1x
Resistor 10k 1x


You can ordering (almost) everything from Adafruit:

Schematics

Mihini EclipseCon2013 Arduino Schematics bb.png


Software parts to reproduce the tutorial

Running Mihini on RaspberryPi

Get SDcard image used during the tutorial

!!!!!Work in progress!!!!!

Get the image here:

    https://www.dropbox.com/s/ftrqfshi62h078t/eclipsecon-raspi-img.tgz

Follow the instructions there:

    http://elinux.org/RPi_Easy_SD_Card_Setup

Mihini version used:

 commit b660318d51a113d58c1e7b7a1ffdac210f5e3352

Compile and run Mihini manually

Available instructions here


Installation of Lua Development Tools (all-in-one bundle)

Home of Koneki Lua Development Tools: http://eclipse.org/koneki/ldt/

Default version of Koneki doesn't come with Remote Target Management feature (that enables, for this tutorial, to connect to RaspberryPi system, send your application to it etc).

To create the all-in-one bundle that was provided during the tutorial, you have to: TBD


Setting up the Arduino

Arduino code used for the tutorial is -->

https://github.com/kartben/mihini-greenhouse-demo/tree/master/SimpleModbusSlaveExample


M3DA Server

An instance of M3DA server is running on Eclipse M2M machine.

To contact it with Mihini agent, you must use this address:

    tcp://m2m.eclipse.org:44900 

Run you own M3DA server instance:

Everything you need for that is there (How to build, to run, interact with):

   https://github.com/SierraWireless/m3da-server


End user Android application

Get it there: http://git.eclipse.org/c/mihini/org.eclipse.mihini.samples.git/tree/greenhouse/corona-greenhouse-demo

Develop the Lua Application

See the slides and code solution in #Tutorial material!!