Tutorial on Eclipse Leshan Internet of Things (2IMN15) , Eindhoven University of Technology By Leila F. Rahman

Size: px

Start display at page:

Download "Tutorial on Eclipse Leshan Internet of Things (2IMN15) , Eindhoven University of Technology By Leila F. Rahman"

Christopher White
6 years ago
Views:

Tutrial n Eclipse Leshan Internet f Things (2IMN15) 2016-2017, Eindhven University f Technlgy By Leila F. Rahman (l.f.rahman@tue.nl) Eclipse Leshan is an pen surce LWM2M prgramming framewrk in Java.

1 Tutrial n Eclipse Leshan Internet f Things (2IMN15) , Eindhven University f Technlgy By Leila F. Rahman (l.f.rahman@tue.nl) Eclipse Leshan is an pen surce LWM2M prgramming framewrk in Java. This tutrial is abut hw t install Leshan and t develp LWM2M client and LWM2M server using Eclipse Leshan fr the Internet f Things (21MN15) practical. This tutrial uses Leshan versin M15 which can be dwnladed r clned frm In this tutrial, we prvide sme guides fr the fllwing: 1. Leshan Installatin n Linux 2. Leshan Installatin and Develpment n Windws using Eclipse IDE fr Java 3. Run time screenshts f leshan-server-dem 1 LESHAN INSTALLATION AND EXECUTION ON LINUX Install and run Leshan versin M15 by fllwing the steps n: Apache Maven and JDK 7 have been installed n the Raspberry Pi and their directry have been set t the PATH envirnment variable during any shell launch (.bashrc) and therefre can be called frm any lcatin, as shwn in Figure 1 and Figure 2. Figure 1. Versin f Maven and Java Develpment Kit Page 1 f 10

Figure 2. Setting directry f Maven and JDK t the PATH envirnment variable in.bashrc 2 LESHAN INSTALLATION AND DEVELOPMENT ON WINDOWS USING ECLIPSE IDE FOR JAVA 2.1 INSTALL LESHAN ON ECLIPSE IDE 1.

2 Figure 2. Setting directry f Maven and JDK t the PATH envirnment variable in.bashrc 2 LESHAN INSTALLATION AND DEVELOPMENT ON WINDOWS USING ECLIPSE IDE FOR JAVA 2.1 INSTALL LESHAN ON ECLIPSE IDE 1. Dwnlad Java SE 7 JDK (which include JRE) frm 2. Dwnlad and install Eclipse IDE fr Java EE develper frm 3. Dwnlad the zip distributin f eclipse/leshan versin M15 frm 4. Extract the zip file int the Eclipse Wrkspace directry 5. Open Eclipse and imprt the Leshan prject t Eclipse by accessing File -> Imprt-> Maven -> Existing Maven Prjects and specify the directry f the prject in the Eclipse Wrkspace flder 6. Add jre7 t the Installed JREs menu in Windw -> Preferences -> Java -> Installed JREs, and set jre7 as default executin envirnment 7. Under the Installed JREs menu, which is the Executin Envirnment menu, set the cmpatible JRE fr JavaSE-1.7 t jre7. Page 2 f 10

3 2.2 DEVELOPING USER APPLICATION USING LESHAN-SERVER-DEMO Open leshan-server-dem prject: a LWM2M dem server with a web UI. Fix the POM File by adding <phase>package</phase> belw line 122 Update the prject by right clicking n the prject flder and click Maven-> Update Prject Figure 3 shws the architecture f the leshan-server-dem prject Mdify client side files (JavaScript, HTML and CSS files) at src/main/resurces/webapp flder accrding t yur applicatin requirements. Yu can use Angular JS frnt-end framewrk ( as used in the leshanserver-dem prject, r yu can use any ther frnt-end framewrk fr develping yur user applicatin frnt end. The JavaScript cdes call services prvided by the servlets (package rg.eclipse.leshan.server.dem.servlet): EventServlet: listens t registratin and bservatin events ClientServlet: gets all the clients cnnected t the server. Sends READ, WRITE, DELETE, EXECUTE, OBSERVE peratins t LWM2M clients. ObjectSpecServlet: gets pre-defined bject specificatins SecurityServlet: manage DTLS security The fllwing list HTTP API examples that are prvided by the Java servlets: GET This API returns a JSON file describing all the clients registered in the Leshan Server s Client Registry as shwn in Figure 8. GET _resurce This API returns a JSON file describing the value f a resurce in a LWM2M client as shwn in Figure 9. GET This API returns a JSON file describing all the bject mdels recgnized by the Leshan Server as shwn in Figure 10. Lk at the cde f the servlets t find mre HTTP APIs. Yu can develp new servlets which prvide new services and their APIs fr develping yur user applicatin back end and initialize the new servlets in the LeshanServerDem.java class under the // Create Servlet cmment. Run the prject as Java Applicatin, chse LeshanServerDem as the main type. When asked fr the gals n Maven cnfiguratin, input eclipse:eclipse and prceed with running the prject. Page 3 f 10

4 USER DEVICE USER DEVICE MOBILE APP (ANDROID OR IOS) WEB BROWSER HTTP HTTP LESHAN-DEMO-SERVER (PC/LAPTOP) JETTY HTTP SERVER FILES (/webapp) SERVLET CONTAINER - JAVASCRIPT (with Angular JS) - HTML - CSS EVENT SERVLET CLIENT SERVLET OBJECT SPEC SERVLET SECURITY SERVLET LESHAN SERVER (LWM2M SERVER) CLIENT REGISTRY (COAP RESOURCE DIRECTORY) LWM2M REQUEST SENDER OBSERVATION REGISTRY SECURITY REGISTRY COAP SERVER LWM2M LWM2M LWM2M SENSOR/ ACTUATOR DEVICE LWM2M CLIENT (LESHAN / WAKAAMA CLIENT) SENSOR/ ACTUATOR DEVICE LWM2M CLIENT (LESHAN / WAKAAMA CLIENT) SENSOR/ ACTUATOR DEVICE LWM2M CLIENT (LESHAN / WAKAAMA CLIENT) Figure 3. Architecture f leshan-server-dem Java prject Page 4 f 10

5 2.3 DEVELOPING LWM2M CLIENT USING LESHAN-CLIENT-DEMO Open leshan-client-dem prject: a sample f LWM2M client Define yur bject specificatins (frm the IPSO smart bjects expansin pack, r self-defined bjects) in an bjectspec.jsn file. The standard bjects (LWM2M bjects and IPSO smart bjects starter pack) are already defined in /leshan-cre/src/main/resurces/mabjects-spec.jsn Create a new system envirnment variable MODELS_FOLDER that reference the flder with the bjectspec.jsn file In the package rg.eclipse.leshan.client.dem, create classes fr yur LWM2M bjects extending the BaseInstanceEnabler class. In the leshan-client-dem prject, three bject classes are created: MyDevice.java, MyLcatin.java and RandmTemperatureSensr.java. Yu can use ne f these classes as a template fr yur new bjects. In each bject class, specify the actins fr READ, WRITE, EXECUTE, DELETE requests n each resurces f the bject. Initialize the bjects (under the // Initialize bject list cmment in the cde) Run the prject as Java Applicatin T exprt the prject int executable.jar file (t be deplyed n Raspberry Pi fr example), right click n the prject and click Exprt -> Java -> Runnable Jar File Page 5 f 10

6 3 RUN TIME SCREENSHOTS In this sectin we will shw yu run time screen shts f leshan-server-dem (a dem server with web-ui) and a LWM2M client, in this case the leshan-client-dem f Leshan versin M15. Figure 4. LeshanServerDem Web Server is running n n laptp with IP Page 6 f 10

7 Figure 5. Client TuEIOT1611wGUI (LeshanClientDem n Raspberry Pi) is registered n LeshanServerDem Page 7 f 10

8 Figure 6. Object and resurces f TuEIOT1611wGUI Page 8 f 10

9 Figure 7. Object IPSO Temperature and its resurces Figure 8. Output f the /api/clients HTTP request Figure 9. Output f the /api/clients/tueiot1611wgui/3303/0/5700/ HTTP request Page 9 f 10

10 Figure 10. Output f the /api/bjectspecs HTTP request Page 10 f 10

Internet of Things 2017/2018

Internet of Things 2017/2018 LESHAN (pictures from standards docs & software descriptions in presentations) Johan Lukkien Leila Rahman John Carpenter, 1982 1 Guiding questions How does LESHAN support the