Search form

Documentation

Running The Onboarding Samples

There are two types of Onboarding sample applications, an Onboarder and an Onboardee. The Onboarding service framework is both a definition of how a Wi-Fi Radio will function on a device and the AllJoyn™ interface used to communicate.

An Onboardee application is responsible for starting up as a software enabled access point (SoftAP) and advertising that it supports the Onboarding service framework via About Announcements. Once provided a set of credentials, the application will stop advertising as an access point and connect to the target network using the provided credentials.

An application that provides the Onboarder side of the service is responsible for using the Onboarding interface to transmit AP credentials that the Onboardee application should connect to.

The Onboarding interface is defined as follows:

<node>
    <interface name="org.alljoyn.Onboarding">
        <annotation name="org.alljoyn.Bus.Secure" value="true"/>
        <property name="LastError" type="(ns)" access="read"/>
        <property name="State" type="n" access="read"/>
        <property name="Version" type="q" access="read"/>
        <method name="ConfigureWiFi">
            <arg name="SSID" type="s" direction="in"/>
            <arg name="passphrase" type="s" direction="in"/>
            <arg name="authType" type="n" direction="in"/>
            <arg name="status" type="n" direction="out"/>
            <annotation name="org.alljoyn.Bus.DocString.en" value="Configure WiFi"/>
        </method>
        <method name="Connect">
            <annotation name="org.freedesktop.DBus.Method.NoReply" value="true"/>
            <annotation name="org.alljoyn.Bus.DocString.en" value="Connect"/>
        </method>
        <method name="Offboard">
            <annotation name="org.freedesktop.DBus.Method.NoReply" value="true"/>
            <annotation name="org.alljoyn.Bus.DocString.en" value="Offboard"/>
        </method>
        <method name="GetScanInfo">
            <arg name="age" type="q" direction="out"/>
            <arg name="scanList" type="a(sn)" direction="out"/>
            <annotation name="org.alljoyn.Bus.DocString.en" value="Get WiFi Scan Information"/>
        </method>
        <signal name="ConnectionResult">
            <arg type="(ns)"/>
            <annotation name="org.alljoyn.Bus.DocString.en" value="Connection Result"/>
        </signal>
    </interface>
</node>

Onboarder samples are available for Linux, Android and iOS. Onboardee samples are available for Android.

The samples can be run on the following platforms:

For future news and updates, please follow or visit https://t.co/MKr1Z9NPji
10 months 2 weeks ago