Skip to content

Latest commit

 

History

History
153 lines (89 loc) · 5.82 KB

gsg-sw.md

File metadata and controls

153 lines (89 loc) · 5.82 KB

Getting Started with IoTivity (Device Simulation)

Introduction

This guide will show you how to download, build, and run two simulated devices on the same Linux PC:

  • The server, a command-line app, simulates a smart home device such as a smart thermostat.
  • The client, a GUI app, controls the smart device. The client typically runs on a smart phone.

The two apps talk to each other over a loopback connection, using the OCF protocol.

![OCF protocol over loopback connection](C:\Users\Roni\Desktop\work today\Concrete (Creative Circle) 2019\Images\OCF protocol over loopback connection.png)

To use Windows: To download, build, and run on Windows PC instead, check the Iotivity FAQ.

Requirements

To carry out this tutorial, you need the following:

  • A Debian-based Linux PC (e.g., Ubuntu), with an internet connection.

Install and Run the Server App

  1. On the Linux PC, open a terminal.

  2. Download source and set up the IoTivity-Lite environment by running this command:

    curl https://openconnectivity.github.io/IOTivity-Lite-setup/install.sh | bash

    Alternatively, you can download the install.sh script, review it, and run it from anywhere.

  3. Generate code for the server app by running these commands:

    cd ~/iot-lite/
./gen.sh

    This script runs the DeviceBuilder app with a default JSON configuration file that can be edited to specify the capabilities of your actual device.

  4. Build and run the server app by running these commands:

    ./build.sh
./run.sh

The server app is now waiting for commands from the client app, which you’ll install next.

Install and Run the Client App

The sample client application is called OTGC (Onboarding Tool and Generic Client). It’s prebuilt, so you’ll just install the binary with a script.

  1. Open another terminal.

  2. Download and install the Linux OTGC client by running this command:

    curl https://openconnectivityfoundation.github.io/development-support/otgc/linux/install.sh | bash

  3. Launch the Linux OTGC client by running this command:

    /usr/bin/otgc.sh

    The client application loads, and your server device (which, in this simulation, is simply another process on your PC) appears in the list.

    ![](C:\Users\Roni\Desktop\work today\Concrete (Creative Circle) 2019\Images\client application loads.png)

  4. Click the server device in the list and click the Onboard button.

    ![](C:\Users\Roni\Desktop\work today\Concrete (Creative Circle) 2019\Images\click the Onboard button.png)

  5. Change the device name, if you wish, and click OK.

  6. In the Generic Client tab, toggle the Value switch on and off.

    ![](C:\Users\Roni\Desktop\work today\Concrete (Creative Circle) 2019\Images\toggle the Value switch on and off.png)

    Notice that the console output in the server terminal responds to the actions in the client. This simulates controlling your smart home device with, for example, a mobile phone client.

  7. Quit the client app and press Ctrl-C in the server terminal to exit the process.

Customize the Code

[Needs detail from OCF] IoTivity provides a tool for automatically generating server code as a significant head start for your software development. The code generation tool works from a JSON file created by you that describes the capabilities of your device.

The server code you compiled and ran in this tutorial began from a file called example.json, found in the ~/iotivity-lite/ directory.

The steps below will show you how to make a simple change to the JSON file, recompile, and run the server and client. You can then see how the server changes are reflected in the client app.

  1. Back up the example.json file:

    cd ~/iot-lite/ 
cp example.json example.json.bak

  2. Open the example.json file in your preferred editor.

  3. [Insert editing steps here]

  4. While still in the ~/iot-lite/ directory, generate the server code, build, and run:

    ./gen.sh
./build.sh
./run.sh

  5. Run the client app:

    /usr/bin/otgc.sh

  6. As before, select the discovered device. Notice the changed capabilities. [screenshot of new capabilities]

Run on Separate Devices

Now that you’ve run a quick simulation on your own development PC to experience the basic flow, you can get a better picture of IoTivity capabilities by running it on a Raspberry Pi board, where you can control and read its status from an Android phone.

A workshop kit includes a Pimoroni input/output board that most clearly shows the capabilities of IoTivity. If you already have a Raspberry Pi board and don’t want to order the full kit, you can run a simpler demonstration.

[roni]Tutorial for Raspberry Pi kit with input/output

Sample project code and instructions for kit including Raspberry Pi and Pimoroni Explorer HAT input/output board.

[roni]Tutorial for plain Raspberry Pi with output only

Sample project code and instructions for bare Raspberry Pi board. [To be developed by OCF]

Next Steps for Development

To learn more about developing IoT devices with IoTivity, read the following:

Development workflow tutorial

Create a whole separate test project (create configuration file, generate device server code, build, and use). [To be developed by OCF. This tutorial will go beyond the simple Customize the Code exercise above. It will walk the developer through creating a new project from scratch.]

Development workflow reference

Folder structure, recommended development flow, and description of core scripts.

Detailed programming guide

From initializing the stack through managing scenes and details in between.