Tech College Aalborg. HomePort. Projekt Smart Zenior Home Guide til udvikling af nye adaptere til HomePort

Transkript

1 Tech College Aalborg HomePort Projekt Smart Zenior Home Guide til udvikling af nye adaptere til HomePort

2 Indhold HomePort Adapter Step-for-Step... 2 Linux... 2 Installér IDE... 2 HomePort på GitHub... 2 Det første HomePort adapter projekt... 3 HomePort Demo filer... 5 Tilføj demo_files folderen til projektet:... 5 Edit Configuration:... 5 Run/Debug Configurations:... 5 Run example demo:... 5 HTTP Request... 6 GET... 7 Get device list:... 7 GET device value:... 8 PUT... 8 PUT device value:... 8 Test RESTful Webservice i CLion... 9 GET PUT

3 HomePort Adapter Step-for-Step Dette dokument er en trin-for-trin-vejledning til at etablere et HomePort udviklingsmiljø og lave et HomePort adapter projekt. Linux det frie styresystem GNU/Linux til computere Du kan sagtens bruge Linux uden at skulle have en nørd-eksamen. Hvis du ikke har prøvet det før ligger der en række trin-for-trin-vejledninger på Ludvigs Hjørne. Jeg bruger Ubuntu, der er en variant baseret på Debian GNU/Linux. Ubuntu er enkel og brugervenlig og der findes talrige gratis programmer på Ubuntu App Store, fx. LibreOffice (kontorpakke), GIMP (billed editor) og Shotcut(video editor). Linux kan installeres som en ren linux maskine eller, hvis du kun har én computer, i en virtuel maskine på en windows computer. Der ligger en vejledning på WebsiteForStudents.com. Installér IDE CLion er ligesom Visual Studio et integreret softwareudviklingsmiljø (IDE fra engelsk Integrated Development Environment). Download og installer CLion fra JetBrains. Hvis du er studerende kan du få en gratis licens til alle JetBrains produkter på HomePort på GitHub Hvis du ikke allerede er bruger kan du oprette dig som bruger på github.com. Download og installer HomePort ved at følge vejledningen på home-port.github.io. (Læs evt. introduktionen først HomePort Introduction). 2

4 Det første HomePort adapter projekt Start CLion Lav et nyt Projekt Vælg C Executable C99 Indtast navn på projektet fx. Demo Isabella Sihm Ziersen Run Build Check at der ikke er nogen fejl [100% = OK] Slet Main Fravælg Safe delete el. Ignorer Advarsler Vælg CMakeList.txt Erstat set(cmake_c_standard 99) add_executable(demo main.c) med koden på næste side 3

5 # Build flags set(cmake_c_flags "-std=gnu99") set(cmake_c_flags_debug "${CMAKE_C_FLAGS} -g -DDEBUG -Wall -D_GNU_SOURCE") set(cmake_cxx_flags "-std=gnu++0x") set(cmake_cxx_flags_debug "${CMAKE_CXX_FLAGS} -g -DDEBUG -Wall -D_GNU_SOURCE") # -fpic is for compiling on 64bit if (CMAKE_SIZEOF_VOID_P EQUAL 8) set(cmake_c_flags "-fpic ${CMAKE_C_FLAGS}") set(cmake_c_flags_debug "-fpic ${CMAKE_C_FLAGS_DEBUG}") endif (CMAKE_SIZEOF_VOID_P EQUAL 8) #.. and for cross-compiling against arm if(cmake_system_processor STREQUAL armhf) set(cmake_c_flags "-fpic ${CMAKE_C_FLAGS}") set(cmake_c_flags_debug "-fpic ${CMAKE_C_FLAGS_DEBUG}") endif(cmake_system_processor STREQUAL armhf) # Find packages find_path(hpd_inc_0_6 hpd-0.6/hpd_api.h) find_library(hpd_lib_0_6 libhpd.so.0.6) find_library(hpd_lib_0_6_rest libhpd-rest.so.0.6) find_library(hpd_lib_0_6_json libhpd-json.so.0.6) find_library(hpd_lib_0_6_thread libhpd-thread.so.0.6) find_library(hpd_lib_0_6_mem libhpd-mem.so.0.6) find_library(hpd_lib_0_6_curl_ev libhpd-curl-ev.so.0.6) find_library(hpd_lib_0_6_map libhpd-map.so.0.6) find_library(hpd_lib_0_6_log libhpd-log.so.0.6) # Check dependencies if(hpd_lib_0_6 AND HPD_INC_0_6) message(status "Using Homeport v0.6: ${HPD_LIB_0_6} [${HPD_INC_0_6}]") include_directories(${hpd_inc_0_6}) else() message(fatal_error "Homeport library v0.6 not found") endif() Reload Changes Nu er du klar til at kopiere HomePort demo-filerne ind i dit nye projekt! 4

6 HomePort Demo filer Da du downloade og installerere HomePort-projektet ved at følge vejledningen på homeport.github.io blev der oprettet et CLion Projekt Åben mappen:clionprojects i filsystemet Find mappen: demo_files (CLionProjects HomePort Example demo_files) Find din projekt mappe : fx. Demo (Hvis du kaldet projektet Demo ) Kopier mappen demo_files fra Home port projektet til din projekt mappe. Vend tilbage til CLion: Kontroller at mappen demo_files nu ligger i din project explorer. Tilføj demo files til projektet: Åben CMakeList.txt Tilføj linen: add_subdirectory(demo_files) Reload Changes Edit Configuration: Edit Configuration (Alt+Shift+F9) Vælg Edit Configuration Run/Debug Configurations: Vælg example_demo Vælg Single instance only Intast Program argument:--rest-port=8080 Apply (eller Debug) Run example demo: Kør demoen ved at trykke på: Example_demo RunDebug 5

7 HTTP Request Lav en ny http Request Vælg New HTTP Request Indtast navnet på http filen fx. request Isabella Sihm Ziersen Kopier nedenstående kode til den nye fil fx. request.http GET Accept: application/json Cache-Control: no-cache ### GET Accept: application/json Cache-Control: no-cache ### PUT Accept: application/json Cache-Control: no-cache Content-Type: application/json {"_value": "2"} 6

8 GET Get device list: For at få en device liste bruges http-metoden Get Vælg request e.g. GET Run localhost:8080 Linket vil åbne en device list i browseren Device listen i browseren 7

9 GET device value: Http-metoden Get bruges også til at få en device value Vælg request: GET Run localhost: 8080 Link vil åbne Device value i browser Device value: PUT PUT device value: For at ændre en device liste bruges http-metoden PUT. Skift device value i request til ny værdi fx. 33 Vælg request: PUT Run localhost: 8080 Device value opdateret til den nye værdi 8

10 Test RESTful Webservice i CLion Som alternativ til at skrive dine egne HTTP-request kan du bruge du bruge CLions Test RESTful Webservice Åben device listen i en browser Device value Marker og kopier URI (Uniform Resource Identifier) for device fx. /demo_adapter/dev0/srv0 Åbn device value på ny tab Vælg Tools->Test RESTful webservice Åbn Rest Client 9

11 GET Få en liste over devices: HTTP method: GET Host/port: Path: /devices Respons: Få værdien af en device: HTTP method: GET Host/port: Path: /demo_adapter/dev0/srv0 Respons: Note: Marker og kopier responsen fx. <?xml version="1.0" encoding="utf-8"?><_value>13</_value> (du skal bruge den til at ændre værdien via http metoden PUT) PUT Sæt værdien på en device: HTTP method: PUT Host/port: Path: /demo_adapter/dev0/srv0 Vælg Text og Indsæt response fra GET i Request Body Request Body: <?xml version="1.0" encoding="utf-8"?><_value>13</_value> 10

12 Tilføj Header: Headers Name: Content-Type Value: application/xml Skift value in Request body til ønsket værdi fx. 44 og run PUT request Respons: Respons i Browser: 11