Gateway Agent Project

Gateway Agent Main Features

  • Provides a special AllJoyn routing node for secure and manageable connections with external network devices and services.
  • Supports plug-in Connector Apps to facilitate interoperable, third-party service connections with AllJoyn device applications. Note: Connector Apps can be contributed as separate AllJoyn projects supporting the Gateway Agent, or developed as proprietary Connector Apps
  • External access rights are managed by the local network owner, using a or with granted authority by a services provider
  • Examples use cases: typically will be run in an always-on device in the LAN (hub, appliance) or a router or Internet gateway
    • Provide secure remote access for AllJoyn mobile apps to AllJoyn devices that are in the local network at home
    • Support a third-party managed services for AllJoyn automation applications
    • Implement protocol conversion between an AllJoyn network segment and other non-AllJoyn automation devices and protocols. i.e. between AllJoyn and popular layer 2 automation protocols (Z-wave, ZigBee, BLE, etc)
    • Join multiple local AllJoyn networks into a larger multiple segment network



Scheduled for release March 2016 Gateway Agent 15.09 Release Plan

This release adds the following to the 15.04 release:

  • Support for AllJoyn Core and Base Services 15.09
  • JavaScript Connector applications
  • Package Manager to download and install aftermarket Connector applications
  • Bug fixes


Scheduled for release January 2016 Gateway Agent 15.04 Release Plan

This release includes:

  • Support for AllJoyn Core and Base Services
  • Bug fixes.

NOTE: The first version of this release will not include iOS.


The Gateway Agent is released supporting AllJoyn Core 14.12. With this release, the main components are:

  • Gateway Management Application
  • Sample connector application (example for AllJoyn to Twitter)
  • Control Application (for Android and iOS) for managing the Gateway Agent service profile

Release information for 14.12 version

Base Implementation Information (for AllSeen Alliance IP Policy)

The Gateway Agent project released version 14.12 of the Gateway Agent on 19 April 2015. This release is now a candidate for inclusion in the Base Implementation. It was presented to the TSC on 20 April 2015 and unanimously approved. The Alliance Board was notified on 21 April 2015 that this Base Implementation component was accepted. With this notification, the initial 90 day review period for 14.12 Gateway Agent began and will complete on 20 July 2015 at midnight PST. Upon completion of the review, the 14.12 Gateway Agent candidate will become an official component of the Base Implementation. See for more information.

Connector Projects

You can contribute to the Gateway Agent by creating a Connector App. Connectors bridge one or more devices to your cloud service.

Connector code may be proprietary, but connectors are more useful to the public as open source projects. Although you would be creating a connector for free and public use, you can still profit from open-source connectors by charging the usage of your cloud services.

You can publish your connector app as part of the Allseen Gateway Agent code, exposing it to developers interested in using Connector apps.

Here is the process to contribute a Connector:

  1. Propose a project to the Technical Steering Committee (TSC). See the Proposing a Connector Project page to understand how to do this.
  2. The project will be introduced to the TSC at the next meeting and two weeks later they will vote on its approval.
  3. Assuming the project is approved by the TSC the committers will be given access to the git repository.
  4. It is suggested that at least one representative from the team working on the project attend the Weekly Technical Meetings while it is being developed.
  5. Contributions to the repository will be submitted to Gerrit for review by other committers in AllSeen before being published to the repository. The Contribution Training article provides details on this process.

Getting Started

Please refer to the Getting Started page for more information.


Weekly Technical Meetings

Working group weekly technical meetings for active contributors and for interested Alliance members and others interested in this working group. Details of the schedule, and the Webex information are at the following page.


The authoritative committer list is on the Project Committers page. Names are also listed here to provide additional contact information.


Qualcomm Connected Experiences, Inc.


Overview Presentations

Design Documents and Specifications

  1. Interface Definition Document See the 14.12 Release information section above on this page.
  2. Test Cases Specification Document See the 14.12 Release information section above on this page.
  3. API Specification Linux Gateway Agent This is the formal API specification for the Gateway Agent Connector Interface Service in Linux. Use this for developing Connector plug-ins to the Gateway Agent application. gateway_connector_service_api_guide_linux_2015_0203.pdf
  4. API Specification Control Application This is the formal API specification for the Control Application interface of the Gateway Agent. It is for developing Control Applications that configure the Service Profile and manage the Connector Plug-ins state for the Gateway Agent. An example is implemented in the Android Java Control Application. gateway_controller_framework_api_guide_java_2015-0204a.pdf
  5. High Level Design Document - The specification document for the Gateway Agent Design.
    1. Update 2 - changes to interfaces, text and diagrams for capturing Connector Id (instead of App Id) as the unique identifier for the connector apps. Gateway Agent HLD - Update 2 Gateway Agent HLD - Update 2 (Redline Version)
    2. Amendment 1 - Adds a Service Provider Mode optimized for broadband operators, automation services providers, or product with services providers. This details the TR-069 management features of the Gateway Agent for secure provisioning and management control by a services provider. Gateway Agent HLD Amendment 1
    3. Update 1 - revises component names for improved clarity and consistency for interaction with other projects. Gateway Agent HLD - Update 1

Original Proposal and Proposal Presentation

  1. The working group proposal document: Gateway Agent Proposal
  2. Presentation to the TSC of the working group proposal: gateway_working_group_proposal_presentation.pdf

Other Files

14.12 release

Jenkins builds

  • RB15.04 - continuous builds against RB15.04
  • RB14.12 - continuous builds against RB14.12
  • master - continuous builds against master
  • verify - verify builds for gerrit patches (master and RB14.12 changes)
  • tagged - tagged builds (for building from a release tag)

Views referenced above include jobs for building the Android Gateway Controller SDK, iOS Gateway Controller SDK, Documentation, Linux binaries, and OpenWrt ipks. The OpenWrt build currently produces ipks for the ar71xx platform based on the Barrier Breaker 14.07 release. Current testing platform is TP-Link TL-WR842ND

Gateway Agent Test Cases

Scroll to Top