Samsung ARTIK05x/Shoreline icast 2 ThingWorx agent Setup Guide Version 1.0

Transcription

1 Samsung ARTIK05x/Shoreline icast 2 ThingWorx agent Setup Guide Version 1.0

2 Introduction... 1 About Samsung ARTIK05x and Shoreline icast Samsung ARTIK 05x Set-up... 3 Accessing ARTIK 05x from serial connection (Windows Users)... 3 Accessing ARTIK 05x from serial connection (Mac Users)... 5 Configuring WiFi on ARTIK 05x... 6 Building ThingWorx agent and example application... 8 Adding ThingWorx agent and example application into TizenRT source... 8 Extending TizenRT to support ThingWorx agent and example application... 8 Configuring and Running the ThingWorx Example Application Changing the Hostname, App Key Compiling ThingWorx example and re-flashing ARTIK 05x firmware image Viewing the streamed data from ThingWorx Portal Troubleshooting Compatibility Document Revision History... 14

3 Introduction The ThingWorx agent is a powerful component of the ThingWorx architecture. The agent allows for the rapid deployment of connections between the ThingWorx platform and an associated data reporting device, with minimal design requirements on the part of the user. This document provides installation and usage instructions for installing the ThingWorx agent on the ARTIK05x WiFi IoT modules and Shoreline icast 2. About Samsung ARTIK05x and Shoreline icast 2 Samsung ARTIK 05x The Samsung ARTIK05x series (ARTIK 053, ARTIK 053s, ARTIK 055s) smart IoT modules and Shoreline icast 2 IoT Bridge (powered by Samsung ARTIK 053) bring WiFi to things that need compactness and connectivity, but without sacrificing hardware-based security. The secure modules, ARTIK 053s and ARTIK 055s, also have built-in, enterprise-grade security for a strong root of trust with Samsung Public Key Infrastructure (PKI) and mutual authentication to ARTIK Cloud service. Each Samsung ARTIK IoT module is a true System on Module(SoM), with CPUs, networking, wireless radios, and full system software stack, all built onto a single, easy-to-integrate package. The ARTIK 05x family run TizenRT OS, a platform that includes a compact RTOS with built-in TCP/IP stack and support for Lightweight Machine-to-machine(LWM2M) protocol. ARTIK 05x series support: 32-bit ARM Cortex R4@ 320MHz for application 29 dedicated GPIO ports, 2 SPIs, 4 UART(2-pin), 4 ADC, 1 JTAG, 2 I2C Input voltage: 3.3VDC(ARTIK 055s), 5-12VDC(ARTIK 053/053s) Shoreline icast 2 Shoreline icast 2 hardware uses ARTIK 053 module and provides a rich set of (Cloud configurable) analog and digital sensors interface to attached legacy sensors to the Cloud based SCADA and analytics system. It provides connections to MODBUS ports to industrial/commercial equipment to gain insight into operations and run equipment at peak performance. It allows actions on error conditions using the outputs to safely shut down equipment and prevent damage, signal alarm conditions on the factory floor, or control proportion-al valves and pumps to slow or shut down processes. Shoreline icast 2 provides: WiFi Radio 2.4 GHz BLE 5.0 Radio, including long Range Radio & Thread SW stack optional 1

4 Antenna design optimized for WiFi and BLE co-existence Three 0-10V/4-20mA analog inputs Two 5-24 VDC digital inputs Two digital outputs One 0-10V/4-20mA analog output One grove I2C interface 3.0kvrms Isolated Relay output 2.5kvrms Isolated RS485 serial port 10-30VAC/12-42VDC power input 256-bit AES/DES/TDES, SHA-1/SHA-2, PKA, PRNG/DTRNG Enclosure: DIN Rail mounted with push connectors Figure 1 ARTIK 053/053s starter board 2

5 Samsung ARTIK 05x / Shoreline icast 2 ThingWorx Agent Setup Guide Figure 2 ARTIK 055s starter board Figure 3 Shoreline icast 2 IoT bridge Samsung ARTIK 05x/Shoreline icast 2 Set-up Connect the ARTIK05x starter board to your host machine using a USB cable. Accessing ARTIK 05x starter board from serial connection (Windows Users) 1. You ll need to determine the COM port number assigned to your ARTIK 05x. Start with the USB cable unattached, then watch Device Manager to see which device appears when you plug it in. 3

6 Type device manager and Enter, 2. Check the COM port number when you connect a USB serial cable to the PC. You may need drivers for the USB serial port. You can find the drivers here: Refer to the Troubleshooting section of this guide for help with frequently asked questions. 3. Open PuTTY or similar serial console terminal client: 4

7 Serial line is the COM port number found previously. Set speed to "115200". Set connection type to "Serial". Name and save the session. 4. You should see TASH shell like this: Accessing ARTIK 05x starter board from serial connection (Mac Users) 1. In Terminal, type the following command (replace XXXXwith the correct ID, which is normally 141B or 142B): 5

8 $ screen /dev/tty.usbserial-xxxx You will see TASH shell in serial console. Accessing Shoreline icast 2 from serial connection On Shoreline icast 2, there is a JTAG port next to ARTIK 053 module, with the name JTAG_ARTIK. You need to connect it to a USB to TTL serial cable for serial access. Configuring WiFi on ARTIK 05x/Shoreline icast 2 ARTIK 05x is WiFi module, please follow the steps below to configure WiFi first. When you first boot up your ARTIK 05x, you will see messages below in the serial console: U-Boot g814fa7d (Jan :17: ) CPU: 320 MHz Model: ARTIK-05x based on Exynos T20 DRAM: 1.3 MiB WARNING: Caches not enabled BL1 released at :00 SSS released at WLAN released at Flash: 8 MiB *** Warning - bad CRC, using default environment In: serial@ Out: serial@ Err: serial@ Autoboot in 50 milliseconds gpio: pin gpg16 (gpio 46) value is 1 ## Starting application at 0x040C s5j_sflash_init: FLASH Quad Enabled 6

9 i2c_uioregister: Registering /dev/i2c-0 i2c_uioregister: Registering /dev/i2c-1 System Information: Version: 1.0 Commit Hash: 412a99dfeef802237d9463b9fb292a0f1fcacda6 Build User: Build Time: :51:34 System Time: 01 Jan 2010, 00:00:00 [s] UTC Hardware RTC Support TASH>>Hello, World!! 1. Start wpa supplicant in station mode TASH>>wifi startsta ***************************************************************** * Samsung System LSI wifi application for t20 * ***************************************************************** Link call back handles registered - per default! Starting supplicant in foreground... STA mode started successfully 2. Configure your SSID and Password. TASH>>wifi join <SSID> <Password> ***************************************************************** * Samsung System LSI wifi application for t20 * ***************************************************************** Link call back handles registered - per default! Joining network SSID Security: wpa2_aes Passphrase: <password> Connected to network: bssid: d0:03:4b:d8:cd:08, ssid: <SSID> Successfully joined the network with SSID <SSID> 3. Obtain an IP address on your device: TASH>>ifconfig wl1 dhcp IP address Netmask Gateway Do a ping test from your console and make sure you have Internet connection. TASH>> ping PING ( 32 bytes of data.count(10) 40 bytes from : icmp_seq=1 ttl=255 time=90ms 40 bytes from : icmp_seq=2 ttl=255 time=160ms 40 bytes from : icmp_seq=3 ttl=255 time=120ms 7

10 Building ThingWorx agent and example application To build ThingWorx agent for ARTIK 05x, we have to use the advanced development option introduced at Adding ThingWorx agent and example application into TizenRT source 1. Clone TizenRT from git. $ git clone 2. Compile TizenRT source code. $ cd ~/TizenRT/os/tools/ Depends on which ARTIK 05x platform you are using, configure the kernel config. Here we are demonstrating how to configure for ARTIK 053s. $./configure.sh artik053s/nettest $cd.. $make 3. Extract the thingworx-agent-artik05x.tar.gz package (included in this starter kit). thingworx-agentartik05x.tar.gz contains two packages: thingworx-agent contains the entire ThingWorx libraries thingworx-sample contains the ThingWorx example application thingworx-agent source code is taken from ThingWorx C SDK src folder, with TizenRT Makefile. thingworx-sample is based on the SimpleThing example code provided as part of ThingWorx C SDK, with TizenRT Makefile. $ tar xvfz thingworx-agent-artik05x.tar.gz 4. Move extracted packages to the right locations in the TizenRT tree, and change their directory names to thingworx. $mv ~/thingworx-agent-artik05x/thingworx-agent ~/TizenRT/external/thingworx $mv ~/thingworx-agent-artik05x/thingworx-sample ~/TizenRT/apps/examples/thingworx In Application Configuration->Examples, enable ThingWorx example application Extending TizenRT to support ThingWorx agent and example application 1. By default, specified warnings are treated as error messages. In ~/TizenRT/os/Make.defs they are defined in Werror compiler options. We will disable these options for compilation. Look for the following lines in Make.defs, and change Werror to Wno-error. The bolded code is what we changed. 8

11 ARCHCFLAGS = -fno-builtin -mcpu=cortex-r4 -mfpu=vfpv3 ARCHCXXFLAGS = -fno-builtin -fexceptions -mcpu=cortex-r4 -mfpu=vfpv3 ifeq ($(QUICKBUILD),y) ARCHWARNINGS = -Wall -Wno-error -Wstrict-prototypes -Wshadow -Wundef -Wnoimplicit-function-declaration -Wno-unused-function -Wno-unused-but-set-variable ARCHWARNINGSXX = -Wall -Wno-error -Wshadow -Wundef else ARCHWARNINGS = -Wall -Wno-error -Wstrict-prototypes -Wshadow -Wundef -Wnoimplicit-function-declaration -Wno-unused-function -Wno-unused-but-set-variable ARCHWARNINGSXX = -Wall -Wno-error -Wshadow -Wundef # only version 4.9 supports color diagnostics ifeq "$(ARCHMAJOR)" "4" ifeq "$(ARCHMINOR)" "9" ARCHWARNINGS += -fdiagnostics-color=auto ARCHWARNINGSCC += -fdiagnostics-color=auto endif endif 2. In ~/TizenRT/os/FlatLibs.mk, add the bolded code block below under TINYARALIBS += $(LIBRARIES_DIR)$(DELIM)libexternal$(LIBEXT) # Add library for external support. TINYARALIBS += $(LIBRARIES_DIR)$(DELIM)libexternal$(LIBEXT) # Add library for ThingWorx SDK ifeq ($(CONFIG_THINGWORX_SDK), y) TINYARALIBS += $(LIBRARIES_DIR)$(DELIM)libTw$(LIBEXT) endif 3. In ~/TizenRT/external/Makefile, add the bolded code block below for removing ThingWorx agent intermediate files when run make clean. artiksdk_clean: ifeq ($(CONFIG_ARTIK_SDK),y) $(Q) $(MAKE) -C artik-sdk clean endif thingworx_clean: ifeq ($(CONFIG_THINGWORX_SDK), y) $(Q) $(MAKE) -C thingworx clean endif 4. In ~/TizenRT/external/Kconfig, added the bolded config option below for enabling ThingWorx SDK. You can include the code between ARTIK_SDK and IOTBUS configs. select LWM2M_WAKAAMA_CLIENT ---help--- include the ARTIK SDK config THINGWORX_SDK bool "ThingWorx SDK" default n select NETUTILS_WEBSOCKET 9

12 ---help--- include ThingWorx C SDK config IOTBUS bool "IoTBUS api" default n ---help Navigate to the os folder, and run make menuconfig to enable ThingWorx configs. $make menuconfig In External Functions, enable ThingWorx SDK. In Application Configuration->Examples, enable ThingWorx example application 10

13 6. Compile ThingWorx agent into libtw.a. Go to ~/TizenRT/external/thingworx, $ cd ~/TizenRT/external/thingworx $ make This will generate the libtw.a static library and copy the generated library to the appropriate location in the TizenRT tree. Configuring and Running the ThingWorx Example Application Changing the Hostname, App Key By default, this ThingWorx example application uses an instance of ThingWorx on port 8080 over HTTP. We will have to change the ThingWorx host and application key in order to make the example application to connect to your own instance. To make these changes, we must edit ~/TizenRT/app/examples/thingworx/thingworx_example_main.c: $ vi ~/TizenRT/app/examples/thingworx/thingworx_example_main.c Find the section near the top of the file that looks like this: /* Server Details */ #define TW_HOST "localhost" #define TW_PORT 8080 #define TW_APP_KEY "ce22e9e c-9656-ef9f844c784c" And replace localhost with the hostname of your server. You will also have to change the App Key to a key that exists on your server. Look in the Application Keys section of your server and for this example, choose or create an app key that has Administrator privileges. Compiling ThingWorx example and re-flashing ARTIK 05x firmware image Next, we need to compile TizenRT again and reflash your ARTIK 05x board after compilation. Make sure you are at ~/TizenRT/os directory. Connect your ARTIK05x device to the USB port of your host machine. $ make $ make download ALL Now reboot ARTIK 05x, configure WiFi on your ARTIK 05x by following the instruction provided in the previous section of this guide and launch thingworx demo application. TASH>>thingworx_example TASH>>[FORCE] :02:44,980: Starting up [FORCE] :02:46,60: twws_connect: Websocket connected! [FORCE] :02:46,520: BindEventHandler: Entity SimpleThing_1 was Bound [FORCE] :02:46,760: AuthEventHandler: Authenticated using 11

14 appkey = ce22e9e c-9656-ef9f844c784c. Userdata = 0x0 Viewing the streamed data from ThingWorx Portal Creating SimpleThing_1 on your ThingWorx server by importing the entity file ThingWorxEntities.xml provided, you should be able to see SimpleThing_1 in your Composer. Select the Properties tab. Here you should see the isconnected property set to true, indicating that the connection is successful. SimpleThing_1 is bound for the duration of the application run time. To verify, go the Monitoring dropdown at the top right of the Composer, then select Remote Things. The monitoring page of Remote Things should show a green check with information about SimpleThing_1. Also, From SimpleThing_1 Properties tab, you can see the streamed properties data, including count and location from your ARTIK05x. 12

15 For additional guidance and examples, please refer to C SDK tutorial at Troubleshooting Problem When launching thingworx sample application from TASH shell, run into error message below: TASH>>thingworx_example TASH>>[FORCE] :01:02,180: Starting up [ERROR] :01:02,290: twws_create: Error creating BSD socket to be used for the websocket [ERROR] :01:02,290: twapi_initialize: Error creating websocket structure [ERROR] :01:02,290: Error initializing the API When compiling TizenRT source tree, run into error message below: make[1]: Leaving directory '/home/artik/thingworx- Agent/TizenRT-ThingWorx- Solution(s) In~/TizenRT/app/examples/thingworx/thing worx_example_main.c, Please make sure you have replaced the hostname and application key with your own. And the application key you are using needs to have Administrator privilege. Please follow Extending TizenRT to support ThingWorx agent and example application section 4 to generate libtw.a static library first 13

16 055s/os/arch/arm/src' make[1]: Entering directory '/home/artik/thingworx- Agent/TizenRT-ThingWorx- 055s/external' AR: make[1]: Leaving directory '/home/artik/thingworx- Agent/TizenRT-ThingWorx- 055s/external' make: *** No rule to make target '../build/output/libraries/l ibtw.a', needed by 'pass2deps'. Stop. Compatibility This guide has been tested for compatibility with the ARTIK530 and the following ThingWorx platform and operating system: ThingWorx Platform Version ThingWorx 8.1 OS on ARTIK05x TizenRT Thingworx C Edge SDK V2.0 Document Revision History Revision Date Version Description of Change Jan 26, Initial Release 14