Filter results by

Connect to the World

Once flashed with the appropriate image, ARTIK 030 modules can be readily connected through an ARTIK Linux® gateway module to ARTIK Cloud.

This full exercise will take you about an hour of setup time, to:

  • Install phone apps

  • Set up an ARTIK gateway as a Thread® "border router", software that bridges between Thread and the Internet (Wi-Fi®).

  • Install Simplicity Studio to load pre-compiled binary images to the ARTIK 030

  • Print QR codes for easy identification of devices

  • "Commission" the Thread network to allow gateway and Thread devices to use common passphrases.

Most of these are steps that an end user would not need to go through, assuming that you (as a developer) would be delivering these as an integral part of your end product. The actual end-user process of "on-boarding" a device to ARTIK Cloud is fast – under a minute.

Setup Procedure

Step 1. Install phone apps

You need to install two smart phone apps.

  • Thread Commissioning App – for joining ARTIK 030 devices to the gateway using a passphrase.

  • Samsung ARTIK App – for on-boarding ARTIK 030 devices, via the gateway, to ARTIK Cloud.

where to find the app look for this logo Requirements
Samsung ARTIK App

<a href="https://play.google.com/store/apps/details?id=com.artik.onboarding&hl=en" target=_blank">Android phone</a>: from Google Play

Android 5.0
or later
Thread Commissioning App<ARTIK 030 only)

<a href="https://play.google.com/store/apps/details?id=org.threadgroup.commissioner&hl=en" target=_blank">Android phone</a>: from Google Play

Android 4.4
or later

Step 2. Install Border Router and Edge Node Manager

ARTIK 030 devices communicate through an intermediate ARTIK gateway module to reach the Internet and ARTIK Cloud (or other clouds of your choice).

To connect them to the world, you need an Internet-connected gateway that is running a Thread border router and the ARTIK Edge Node Manager.

Follow the Edge Node Manager article (including the part where you on-board the gateway itself) and then return here.

Run the ENM Dashboard and verify that your gateway is online.

Step 3. Load Thread NCP firmware

ARTIK gateway modules are typically pre-loaded with ZigBee NCP firmware. You'll need to load Thread NCP firmware. As a shortcut, if you are using the Thread NCP firmware installed with the OS, you can simply run these commands.

systemctl stop artik-ip-driver
/usr/bin/artik-thread-flash-firmware.sh
reboot

Step 4. Download pre-compiled images

Use the files provided here:  » ARTIK 030 "Connect to the World" Package

Extract the top-level zip file, where you will find two image files; extract these to a convenient location for use in the next step. You don't need to extract the second-level zip file, containing related source code, at this time.

Step 5. Upload images

Install the Simplicity Studio® 4.0 software tool on your host PC. Make sure you have your boards ready to plug in when you install the Simplicity Studio software, so that they are automatically recognized and the appropriate driver stacks installed.

You will be uploading a main image and a bootloader to an ARTIK 030 development board.

  1. Run the Simplicity Studio 4.0 program and go to the Simplicity IDE view.

  2. Connect the board to your PC using the USB cables, making sure the board switch is set to 'AEM'. The device appears on the left of the screen with an identifier number.

  3. Upload the pre-built binary images to the ARTIK 030 board.

    a. Left-click to select the device.
    b. Right-click and choose Upload application… (see note below if not clickable)

    c. Browse to your downloads, and select as the main image:
          A030: artik-edge-node-....ebl
    d. Click the "Bootloader" checkbox and select as its image:
          A030: bootloader-storage-internal-....s37
    e. Click Erase chip so that the chip will be cleared before upload.
    f. Click OK.

  4. Open a terminal emulator console to send commands and check status.
    a. Select the device as you did above.
    b. Right-click and select Launch Console.
    c. Select the Serial 1 sub-tab on the console window.

    Once you launch the console, Simplicity automatically connects a debugger. If you need to upload a different image later, hit Disconnect to again make the Upload application… selection clickable.

  5. On the Simplicity Studio console command line, enter:
    net reset
    Otherwise, the A030 will remain attached to any previous network (even through a push-button reset or power cycle).

  6. Again on the console command line, enter:
    info
    You'll see device and network information, including the Eui64 value.

That was all – you won't need to generate or compile anything for this session. Keep Simplicity Studio open, as you'll be using its console in the next steps.

Step 6. Print QR codes

Use the Print QR Codes article to print device-unique identifiers as QR codes, so the phone apps can readily recognize them. (You won't need to do anything in the "on-boarding" part of that article for now.)

For the ARTIK 030, enter the
info
command in the Simplicity Studio console to retrieve the Eui64. You'll end up with two QR codes: one for the ARTIK app, and one for the Thread app.

Step 7. Generate Border Router passphrase

Tell the ARTIK border router to generate a private br-passphrase. Run this script on your ARTIK gateway module terminal to receive the phrase as shown.
/usr/bin/artik-generate-thread-commissioner-passphrase.sh

    [~]# /usr/bin/artik-generate-thread-commissioner-passphrase.sh
    9F6EB5355A[~]#

Commissioning ARTIK 030

For Thread edge node devices, you need to use the Thread app to "commission" the network: retrieve the private border router passphrase of the gateway module, then send the gateway module the unique identifier and join passphrase of the ARTIK 030.

Preparation

Set the phone to use the same Wi-Fi network as your gateway running Edge Node Manager is using. Make sure you have done net reset on the A030 console.

ARTIK 030 Thread Commissioning
  1. Run the Thread phone app. You should see your ARTIK border router gateway come up (look for its IP address). Select it if asked.

  2. When asked for "Administrative password", manually type the br-passphrase you got into the app. It is CASE-SENSITIVE.

  3. Now use the phone to scan the Thread A030 QR code -- the app captures and then sends the join passphrase and the Eui64 to the ARTIK border router.

  4. Finally - press the PB1 (left) button on the ARTIK 030 board to enable it to join the Thread network of the border router.

With the EUI64 and join passphrase of the A030, the ARTIK border router can now connect with the ARTIK 030 over its Thread radio.

At this point, the Edge Node Manager is aware of your ARTIK A030. Refresh the ENM Dashboard and verify that the A030 is online.

Troubleshooting Hint. If you don't see your border router on the Thread commissioning app, check to make sure you loaded the Thread NCP firmware.

On-boarding ARTIK 030

With Thread commissioning, you enabled your ARTIK gateway module to talk with your ARTIK 030 edge node on the same Thread network. But the gateway has not yet told ARTIK Cloud about the edge node.

You're ready to connect your edge node modules to ARTIK Cloud. You'll use the ARTIK phone app, over Wi-Fi, to tell the gateway module to communicate with ARTIK 030 over the Thread radio.

On-boarding procedure

Use the ARTIK phone app to read the ARTIK app QR code and "on-board" your edge nodes.

Step   Looks like this

1.


2.

Open the app. Any devices you currently have registered will show up.

Press   +  to begin on-boarding.

3.

Select "Use QR code"

4.

Center the ARTIK module QR code that you printed earlier on the screen, and steady the camera. Be sure you are not using the Thread QR code.

The app will register your device name and unique ID.

5.



Enter a name and location – the way you want your edge node to show up on your ARTIK Cloud "Devices" page. Hit Enter.

6.

When asked if the module is powered, attach the A030 kit, either using a USB cable (switch to AEM) or a battery (switch to BAT).

7.



When the app lists border routers, select the one corresponding to your gateway and hit Continue.

8.



Provide the correct password ('admin'). (You'll be able to change this password using the ENM REST API "User – Add" call.)

If the gateway module is able to connect to your chosen border router, the app proceeds to register the edge node module with ARTIK Cloud.

Notes on ENM and on-boarding

For the on-boarding app to work correctly, the ARTIK Linux gateway/hub must be running the Edge Node Manager (ENM) with no problems.

The app cannot proceed beyond a certain point without being connected on the same Wi-Fi network as the gateway. This is different from the on-boarding of the gateway itself, during which the phone need not be on the same network as the gateway.

The ARTIK 030 and ARTIK gateway must be commissioned on the same Thread network before the ARTIK 030 can be seen by Edge Node Manager. Only after the A030 shows as "online" can the on-boarding to ARTIK Cloud take place.

More detailed information is available in the On-boarding article.

Last updated on: