]> Cisco Systems

Brussels Belgium bbrinckm@cisco.com

Cisco Systems

170 West Tasman Drive San Jose 95134 USA rohitmo@cisco.com

Philips

Cambridge USA braeden.sanford@philips.com

Internet-Draft This memo specifies RESTful application layer interface for gateways providing operations against non-IP devices, as well as a CBOR-based publish-subscribe interface for streaming data. The described interfaces are extensible. The specification also defines a protocol mapping function to to map this interface to commonly used non-IP protocols.

Introduction

Scope Low-power sensors, actuators and other connected devices introduced in environments and use cases such as building management, healthcare, workplaces, manufacturing, logistics and hospitality are often battery-powered. With limited power budget, they may not be able to support the IP protocol on their wired or wireless interfaces, hence they support protocols that require a lower power budget. Promiment examples of such protocols are and . These devices typically do require to communicate with devices or applications that are connected to IP-based networking infrastructure. Therefore, applications on the IP network that need to communicate or receive telemetry from these non-IP low-power devices must do so through a gateway function on the IP network. This gateway functions then translates the communication to the non-IP protocol that the low-power device supports.

| Gateway |<------------>| Non-IP | | app | IP-based | | Non-IP | Device | +-------------+ Operation +---------+ Operation +--------+ ]]>

There have been efforts to define Gateway functions for devices that support a particular protocol, such as a BLE GATT REST API for BLE Gateways (), however they have been limited to a single protocol or a particular use case. In absence of an open standard describing how applications on an IP network communicate with non-IP devices, bespoke and vendor-specific implementations have proliferated. This results in parallel infrastructure of both gateways and non-IP networks being deployed on a case by case basis, each connecting separately into the IP network, with a distinct set of APIs. At the same time, wireless access points supporting both IP-based wireless connectivity as well as non-IP based wireless technologies are deployed ubiquitiously. Many of these wireless access points are equipped with radios that can transmit and receive different frame types, such as and . This specification aims to define a Gateway API for these Non-IP protocols that can be leveraged by this wireless infrastructure in order to connect Non-IP devices into IP networks. The specification aims to be extensible, in order to support existing and future non-IP protocols. A standardized Non-IP Gateway interface has following benefits: Avoid the need for parallel Non-IP infrastructure. Avoid the need for applications to perform bespoke integrations for different environments. Faster and more cost-effective adoption of Non-IP devices in IP network environments.

Non-IP Gateway A non-IP gateway MUST provide at least following functions: Authentication and authorization of application clients that will leverage the gateway API to communicate with Non-IP devices. Access to a database of onboarded devices. Onboarding ensures that the Non-IP Gateway can identify a specific device and has sufficient context about the device to service gateway API requests. The ability to consume an interaction model for a class of devices. This allows the gateway to understand how to interact with a device. An API that allows for bi-directional communication to non-IP devices. One or more channels to process requests, responses, and asymmetric communications with the non-IP radio resources (Access Points) at its disposal. The ability to stream telemetry received from non-IP devices in real-time to applications on the IP network. The definition of the onboarding function is out of scope of this document, but can be provided by a provisioning interface such as leveraging . NIPC performs operations on a device or group object, hence it requires device onboarding to be performed prior to performing a NIPC operation on a device. NIPC APIs will reference a device or group id generated at the time of onboarding as a unique identifier. The Application gateway is a network function, so its goal is to proxy payloads between Non-IP and IP networks. It is not intended to be a middleware function that interprets, decodes or modifies these payloads.

| SCIM | | | app |<--------------| Server | | +-----------+ Ctrl Endpt| +---------+ | | | +-----------+ | +------------+ +-------+ +--+ | | Control |>...REST....|.>| NIPC |..| AP |..|D | | | & | | | Gateway | +-------+ +--+ | | Telemetry |<..pub/sub..|.<| | | | Apps | | +------------+ | +-----------+ | | | Network Deployment | +-----------------------------------+ ]]>

shows us applications, the NIPC application layer gateway (ALG), an access point (AP), and a device (D). The applications, application layer gateway and access point are deployed on an IP-Network. The AP supports a Non-IP interface, which it uses to communicate with the device. The Application is deployed in a different administrative domain than the network elements (ALG & AP). The role of the application layer gateway is to provide a gateway function to applications wishing to communicate with non-IP devices in the network domain served by the gateway. Applications implementing Non-IP Control can leverage RESTful interfaces to communicate with Non-IP devices in the network domain and subscribe to events levering a CBOR-based pub/sub interface.

Terminology The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here.

Architecture

Overview Non-IP protocols, such as BLE or Zigbee, typically define a number of basic operations that are similar across protocols. Examples of this are read and write data. NIPC provides a unified API to support those operations. To perform NIPC operations on a device, the gateways needs 2 things: 1) Information about the instance of the device or thing: The device must be onboarded on the gateway (e.g. by means of SCIM). This allows the NIPC Gateway to retrieve the device object, identified by an id referenced in the path of the NIPC API. 2) Information about the interaction model: The Gateway must be able to perform protocol-neutral operations, and hence requires a mapping of protocol-neutral operations to protocol specific operations. These are supplied to the gateway by means of an SDF model, described in .

| | +------------+ | NIPC Operation | | - Property | | - Action | +------------+ | - Event | | SDF |---------->| | | model | +----------------+ | | +------------+ ]]>

Once these 2 prerequisites have been fulfilled, applications that are authorized can perform NIPC operations on device ids. NIPC operations are operations on properties, or constitute actions or events on devices, as per the affordances defined in an SDF model.

Onboarding In order to perform a NIPC operation on a device, the device has to have its identity declared to the NIPC gateway. We refer to this as 'onboarding'. Apart from the device identity, it is also necessary that the device object contains all required information to bootstrap trust with the device, as well as establish connectivity, as NIPC operations assume that connectivity is there. Allthough onboarding could theoretically be performed in other ways, it is strongly recommended to leverage with , as the SCIM device schema has been developed to contain all nessary attributes and extensions to support NIPC.

Registrations NIPC registration APIs allow applications to declare information that is not related to a device instance. Registrations can be information about an interaction model for a class of devices, or information about an application that is required to interact with the gateway.

SDF model registrations The SDF model for a class of devices determines how a gateway may interact with these devices in a protocol-neutral way. In order to do that, the SDF model must contain protocol mappings, mapping protocol-neutral SDF affordances to protocol-specific ones. The SDF affordances supported by the device, as well as its protcol-mappings, are provide to the gateway by means of an SDF model registration. SDF models are described in .

Data application registration An application authorized to perform NIPC operations on devices needs to be able to define which applications can receive streaming event data from the gateway. The data-app registration API allows mapping of an event to a data app as well as a protocol.

Protocol mapping An SDF model fully describes a thing, including all its SDF affordances. To leverage an SDF model to perform protocol specific operations on an instance of that thing, a mapping of the SDF affordance to a protocol-specific attribute is required. In NIPC, this is achieved through protocol mapping. Protocol mapping is required to map a protocol agnostic affordance to a protocol-specific operation, as implementations of the same affordance will differ between protocols. For example BLE will address a property as a service characteristic, while a property in Zigbee is addressed as a property in a cluster of an endpoint. protocol mapping allows for integration of new protocols in NIPC, new mappings can be created without the need to update the base schema.

ble | - BLE property | |> zigbee - Zigbee property ]]>

As shown in , protocol-specific properties must be embedded in a protocolmap object, for example a "ble" or a "zigbee" object. Attribute Req Type Example ble T object an object with BLE-specific attributes zigbee T object an object with Zigbee-specific attributes where- "ble" is an object containing properties that are specific to the BLE protocol. "zigbee" is an object containing properties that are specific to the Zigbee protocol. Other protocol mapping objects can be added by creating a new protocol object Example protocol mapping:

A protocol map is provided as part of the SDF model, in the SDF affordance definition. Alternatively, it can be provided directly in a NIPC API.

NIPC Operations NIPC operations are protocol-neutral operations on SDF affordances, more specifically properties, actions & events. NIPC operations can happen against affordances that were registered in an SDF model. If connection management is required to execute a NIPC operation, it is assumed that the gateway implictly establishes and tears down required connections.

Properties APIs Property APIs allow applications perform operations on properties, such as to read or write values to them.

Actions Action APIs perform actions on devices, such as enabling or disabling a feature on a device.

Events Event APIs allow apps to enable or disable event reporting on devices. Events are reported over the events publish/subscribe interface.

Connection management for NIPC Operations For protocols that require connection management before executing an operation, a NIPC gateway can perform implicit connection management. When executing a NIP operation, a NIPC Gateway can set up a connection with a device as well as tear down the connection after the operation has completed. A NIPC Gateway should support explicit connection management as well. Explicit connection management can be used by an app that wants to perform multiple NIPC operations in a single connection. Explicit connection management can be performed by calling the /devices/{id}/manage/connection action API. When after establishing an explicit connection to a device, an application calls a NIPC Operation, the Gateway will leverage the exissting connection and will also not tear the connection down after the operation completes. The app will have to explicitly close the connection.

Management APIs Management APIs are APIs that perform device connection management and protocol-specific operations, but do not use registered affordances. These APIs have embedded protocol mappings. They require explicit connection management.

Extensions Extensions are not part of the core NIPC API specification, but extensions to it. Extensions are compound APIs. They leverage basic NIPC operations but combine multiple operations in to one API call for efficiency. An example of this is the the bulk operation, allowing to send multiple operations in one operation. Extensions can be generic, IANA registered extentions, or vendor specific extensions.

Events publish subscribe interface Events are published on a publish/subscribe interface. Events can be of different types: Streaming data from devices: Streaming data is activated/deactivated with the NIPC events API Broadcasts from devices Connection events: Devices connecting & disconnecting

Protocols

NIPC APIs NIPC is a protocol that is based on RESTful HTTP . Along with HTTP headers and URIs, NIPC uses JSON payloads to convey NIPC operations, such as registrations, actions, event and property operations. This is the case for both request and response parameters, as well as errors. NIPC uses the standard JSON media type "application/json", except for the SDF model registration APIs, where the media type reflects the content as an SDF model, and hence is media type "application/sdf+json".

NIPC publish/subscribe events NIPC publish/subscribe events are encoded in CBOR () and can be delivered over either: MQTT Webhook Websocket

Paths

General The NIPC HTTP protocol is described in terms of a path relative to a Base URI. The Base URI MUST NOT contain a query string, as clients MAY append additional path information and query parameters as part of forming the request. The base URI is a URL that most often consists of the "https" protocol scheme, a domain name, and an initial path . That initial path for NIPC is recommended to be /nipc. For example:

Based on this a well_known URI of nipc can be defined. Additionally a version number may be added, for example:

NIPC Registrations Registrations leverage the base path + /registration. NIPC supports SDF model registrations and data-app registrations. paths: /registration/model /registration/data-app

NIPC Operations Every NIPC Operations API pertains to either a device or group of devices, identified by an id, hence the id will be reflected as the first parameter in the path. For example:

The second parameter in the path refers to the NIPC operation that the API will perform on the device. This can be: property event action extension These are described in .

Schema The NIPC schema leans heavily on the SDF schema, as defined in . NIPC operations map directly to SDF affordances.

SDF model registration In order to perform a NIPC operation on a device, an SDF interaction model needs to be declared that provides protcol mappings for the SDF affordances the operations will be performed on. The SDF model can be registered by means of a registration API POST with the SDF model in the body of hte request. A registered SDF model can be fetched by a registration API GET with an sdfReference.

NIPC Operations NIPC operations require 2 key parameters: 1) A device ID identifying the device the operation should be executed on 2) an SDF reference for the SDF affordance the operations pertains to

Device ID All NIPC operations are executed against a device or a group of devices. Devices or groups of devices are identified by a unique uuid. Attribute Req Type Example id T uuid 12345678-1234-5678-1234-56789abcdef4 Id is the unique uuid of the device. This id is generated when registering the device, for example against a SCIM server. As such, this id is a common identifier, known both to the application as well as the NIPC Server.

SDFReferences NIPC operations happen against SDF affordances and are referenced with an sdfReference, which is the full path including the namespace. The operations are either Properties, Events or Actions and their references are of type string For example: Attribute Req Type Example Property T string https://example.com/heartrate#/sdfObject/thermostat/sdfProperty/temperature

Responses A NIPC Gateway will respond to a NIPC operation request synchronously, and provide the result of the completed operation in the HTTP response. The exception to the above are NIPC extensions, . These contain compound statements, and thus require the gateway to execute multiple NIPC operations. In this case the NIPC gateway will return HTTP status code 202 after receiving the request and verifying it is able to execute it. The client can then perform an HTTP GET of the extension API to get the execution status for the request. If a callback URL was address was defined in the request, the NIPC Gateway can optionally perform a callback with a response to the compound request after the compound statement completes. Actions also follow an asynchronous pattern, returning HTTP status code 202 when the action is accepted, along with a Location header pointing to the action instance for status tracking. A failure response will consist of a HTTP status code of 4xx or 5xx, and will follow the Problem Details format with application/problem+json media type. The response will contain a type field with a URI identifying the error type, and a human-readable detail field. The type field is a URI and is described in . Failure response: Example of a failure response:

where- "type" is a URI identifying the specific error type "status" is the HTTP status code "title" is a brief, human-readable summary of the error type "detail" is a human-readable explanation specific to this occurrence

NIPC Registrations NIPC allows an application to register an SDF model for a class of devices, as well as a data application that will receive streaming data from the gateway.

SDF model registration APIs These APIs allow applications to register an SDF model for a class of devices. These APIs use the application/sdf+json media type, as described in .

Register an sdf model Method: POST /registration/model Description: Registers an SDF model for a class of devices Request Body: an SDF model in JSON format, similar to the example in . Response: Example of a response:

where- "sdfName" is the reference to the top-level sdfThing or sdfObject in the SDF model

Get all sdf models Method: GET /registration/model Description: Gets all sdf models registered with the gateway Response: Example of a response:

where- "sdfName" is the reference to the top-level sdfThing or sdfObject in the SDF model

Get an sdf model Method: GET /registration/model Description: Gets an sdf model registered with the gateway Query Parameters: sdfName: the reference to the top-level sdfThing or sdfObject in the SDF model. Response: The sdf model is returned in JSON format, similar to the example in .

Delete an sdf model Method: DELETE /registration/model Description: Deletes an sdf model registered with the gateway Query Parameters: sdfName: the reference to the top-level sdfThing or sdfObject in the SDF model. Response: Example of a response:

where- "sdfName" is the reference to the top-level sdfThing or sdfObject in the SDF model

Update an sdf model Method: PUT /registration/model Description: Updates an sdf model registered with the gateway Query Parameters: sdfName: the reference to the top-level sdfThing or sdfObject in the SDF model. Request Body: an SDF model in JSON format, similar to the example in . Response: Example of a response:

where- "sdfName" is the reference to the top-level sdfThing or sdfObject in the SDF model

Data application registration APIs These APIs allow applications to register a data application that will receive streaming data from the gateway. These APIs operate on a data app ID. This ID corresponds to the endpoint app ID of the telemetry endpoint app that is registered with the SCIM server. The endpoint app is defined in .

Register a data application Method: POST /registration/data-app Description: Registers a data application with the gateway Query Parameters: dataAppId: the id of the data application Request Body: events: a list of events that the data application wants to receive streaming data for. The request body also contains one of the following: mqttClient: an empty object that denotes that the data application is an MQTT client that will receive streaming data over MQTT mqttBroker: an object that contains the MQTT broker information where the broker will publish the streaming data. URI: the URI of the MQTT broker username: the username to authenticate with the MQTT broker password: the password to authenticate with the MQTT broker brokerCACert: the CA certificate of the MQTT broker (optional) customTopic: the custom topic to publish the streaming data to (optional) webhook: an object that contains a webhook URL along with any credentials that are required to authenticate the webhook. The webhook URL is the endpoint where the streaming data will be sent. URI: the webhook URL headers: An object that contains the headers to be sent with the webhook request. The headers can contain any authentication information required by the webhook server. serverCACert: the CA certificate of the webhook server (optional) websocket: an object that contains a websocket URL along with any credentials that are required to authenticate the websocket. The websocket URL is the endpoint where the streaming data will be sent. URI: the websocket URL headers: An object that contains the headers to be sent with the websocket request. The headers can contain any authentication information required by the websocket server. serverCACert: the CA certificate of the websocket server (optional) Example of a request body:

Example of a request body for a data application that is an MQTT broker:

Response: If successful, the response will be identical to the request body.

Update a data application Method: PUT /registration/data-app Description: Updates a data application with the gateway Query Parameters: dataAppId: the id of the data application Request Body: Same as the request body for the register data application API. Response: If successful, the response will be identical to the request body.

Get a data application Method: GET /registration/data-app Description: Gets a data application registered with the gateway Query Parameters: dataAppId: the id of the data application Response: The response will be identical to the request body for the register data application API.

Delete a data application Method: DELETE /registration/data-app Description: Deletes a data application registered with the gateway Query Parameters: dataAppId: the id of the data application Response: The response will be identical to the request body for the register data application API.

NIPC APIs The primary goal of the NIPC APIs is to exchange data with a Non-IP device, by means of reading, writing or streaming NIPC properties to applications. The NIPC APIs are divided into 3 categories: NIPC Property APIs: These APIs allow applications to get and update device properties. NIPC Event APIs: These APIs allow applications to enable or disable event reporting on devices. NIPC Action APIs: These APIs allow applications to perform actions on devices. NIPC Management APIs: These APIs allow applications to manage device connections and perform protocol-specific operations. An SDF model must be registered for the device in order to use these NIPC Property, Event and Action APIs. The SDF model can be a top-level sdfThing with multiple sdfObjects or a top-level sdfObject. These APIs depend on the SDF affordance (i.e. sdfProperty, sdfEvent and sdfAction) objects defined in the SDF model and a device ID that is defined in . The SDF affordance can be referenced using the global name of the SDF affordance as described in . The SDF global name will be used against the registered SDF model to determine the protocol-specific protocolMap that the NIPC API will operate on.

NIPC Property APIs These APIs allow applications to get and update device properties. These operations may require a connection to the device to be established. This connection can be established as part of the same API call implicitly. If a connection is already active for this device, the existing connection willi be leveraged without modifying it. These APIs support multiple media types based on Content-Type and Accept headers to accommodate different data formats. When using application/octet-stream, the raw binary data is sent directly in the request/response body. When using application/json, the request and response bodies follow the format shown in the examples above, with binary data encoded as base64 in the "value" field. For other content types, the data is transmitted according to the specific format requirements of that media type.

Write multiple values Method: PUT /devices/{id}/properties Description: Write values to one or more properties on a device Parameters: id: the id of the device Request Body: an array of properties to update, each containing a property and a value Example body updating multiple properties:

Response: Example of a response:

where- "properties" is an array of properties that were updated, each containing a property and a value A failure will generate a standard failed response. Please refer to definition of failed response.

Read multiple values Method: GET /devices/{id}/properties Description: Read values from one or more properties on a device Parameters: id: the id of the device Query Parameters: propertyName: a comma separated list of properties to read Response: Example of a response:

where- "property" is the property that was read from "value" is the bytes that were read in base64 encoding A failure will generate a standard failed response. Please refer to definition of failed response.

NIPC Event APIs These APIs allow applications to enable or disable event reporting on devices. These operations may require a connection to the device to be established. This connection can be established as part of the same API call implicitly. If a connection is already active for this device, the existing connection will be leveraged without modifying it. The event is a global name reference to an sdfEvent. The ID in the path is the id of the device or group of devices. An event can be enabled on a group of devices if it is supported by the underlying protocol. For example, if the underlying protocol is BLE, the event can be enabled on a group of devices if the event is an advertisement event or connection status event. If the data application registered for this event is an MQTT broker or client, the event is used to construct the MQTT topic for the event. The topic is constructed using the data application ID, the default namespace for the event, and the event itself. For example, if the data application ID is "12345678-1234-5678-1234-56789abcdef4" and the event is "https://example.com/thermometer#/sdfThing/thermometer/sdfEvent/isPresent", the topic will be:

// data-app/12345678-1234-5678-1234-56789abcdef4/thermometer/sdfObject/thermometer/sdfEvent/isPresent ]]>

A data application can subscribe to this topic using the topic or it can use MQTT wildcards to subscribe to data-app/+/temperature/# to receive all events for the temperature namespace. If a custom topic is provided for an MQTT broker, the custom topic is used as the MQTT topic instead.

Enable event reporting Method: POST /devices/{id}/events Description: Enables an event on a specific device Parameters: id: the id of the device Query Parameters: eventName: the event to enable The eventName is a URL encoded string that is the absolute URI that is a global name reference to an sdfEvent. Response: Returns HTTP status code 201 Created with a Location header pointing to the created event instance. Example of a successful response:

The Location header contains the URI for the created event instance, which can be used to check status or disable the event. A failure will generate a standard failed response. Please refer to definition of failed response.

Disable event reporting Method: DELETE /devices/{id}/events Description: Disables an event on a specific device Parameters: id: the id of the device or group of devices Query Parameters: instanceId: the instance ID of the event to disable (obtained from the Location header when the event was enabled) Response: Returns HTTP status code 204 No Content on successful disable.

A failure will generate a standard failed response. Please refer to definition of failed response.

Get event status Method: GET /devices/{id}/events Description: Get the status of an event on a specific device Parameters: id: the id of the device or group of devices Query Parameters: instanceId: the instance ID of the event to query Response: Example of a response:

where "event" is the event URI that was enabled for this instance. A failure will generate a standard failed response. Please refer to definition of failed response.

Get status of multiple events Method: GET /devices/{id}/events Description: Get the status of one or more events on a specific device Parameters: id: the id of the device or group of devices Query Parameters: instanceId: a comma separated list of event instance IDs to filter by (optional) Response: Example of a response:

where- "instanceId" is the unique instance ID for each enabled event "event" is the event URI for each enabled event A failure will generate a standard failed response. Please refer to definition of failed response.

Enable event reporting on a group of devices Method: POST /groups/{id}/events Description: Enables an event on a group of devices Parameters: id: the id of the group of devices Query Parameters: eventName: the event to enable The eventName is a URL encoded string that is the absolute URI that is a global name reference to an sdfEvent. Response: Returns HTTP status code 201 Created with a Location header pointing to the created event instance. Example of a successful response:

The Location header contains the URI for the created event instance, which can be used to check status or disable the event. A failure will generate a standard failed response. Please refer to definition of failed response.

Disable event reporting on a group of devices Method: DELETE /groups/{id}/events Description: Disables an event on a group of devices Parameters: id: the id of the group of devices Query Parameters: instanceId: the instance ID of the event to disable (obtained from the Location header when the event was enabled) Response: Returns HTTP status code 204 No Content on successful disable.

A failure will generate a standard failed response. Please refer to definition of failed response.

Get event status on a group of devices Method: GET /groups/{id}/events Description: Get the status of an event on a group of devices Parameters: id: the id of the group of devices Query Parameters: instanceId: the instance ID of the event to check Response: Example of a response:

where "event" is the event URI that was enabled for this instance. A failure will generate a standard failed response. Please refer to definition of failed response.

Get status of multiple events on a group of devices Method: GET /groups/{id}/events Description: Get the status of one or more events on a group of devices Parameters: id: the id of the group of devices Query Parameters: instanceId: a comma separated list of event instance IDs to filter by (optional) Response: Example of a response:

where- "instanceId" is the unique instance ID for each enabled event "event" is the event URI for each enabled event A failure will generate a standard failed response. Please refer to definition of failed response.

NIPC Action APIs These APIs allow applications to perform actions on devices. These operations may require a connection to the device to be established. This connection can be established as part of the same API call implicitly. If a connection is already active for this device, the existing connection will be leveraged without modifying it.

Perform an action Method: POST /devices/{id}/actions Description: Perform an action on a specific device Parameters: id: the id of the device Query Parameters: actionName: the action to perform Request Body: The request body is optional and can contain binary data if the underlying protocol allows an action with a value. Response: Actions are performed asynchronously. A successful request returns HTTP status code 202 Accepted with a Location header pointing to the action instance for status checking. Example of a successful response:

The Location header contains the URI for the action instance, which can be used to check the action status.

Check action status Method: GET /devices/{id}/actions Description: Check the status of an action on a specific device Parameters: id: the id of the device Query Parameters: instanceId: the instance ID of the action (obtained from the Location header) Response: Example of a response:

where "status" indicates the current state of the action (e.g., "IN_PROGRESS" or "COMPLETED"). A failure will generate a standard failed response. Please refer to definition of failed response.

NIPC Management APIs These APIs allow applications to manage device connections, but do not use registered properties, events or actions. These APIs do not perform an implicit connection, so a connection must be established before calling these APIs.

Connect to a device Method: POST /devices/{id}/manage/connection Description: Connect to a device Parameters: id: the id of the device Request Body: Connection retry parameters A protocol map object. In the case of BLE, if no protocol map is included, service discovery is performed to discover all supported properties when connecting to a device. Optionally, service discovery may be limited to properties defined in the "ble" protocol extension. The services to be discovered can be added in an array. Property discover can be buffered across connections, so the API also supports caching parameters. Example body of a connection without specific discovery of properties:

where- "retries" defines the number of retries in case the operations does not succeed "retryMultipleAPs" can be used in case there is an infrastructure with multiple access points or radios that can reach the device. If set to "true" a different access point may be used for retries. In case the application would like to discover specific properties of a device, a protocol mapping can be added that defines what properties should be discovered. Example body of a BLE connection with specific discovery of properties:

where in the BLE protocol object: "services" is an array of services defined by their serviceIDs. "cached" refers to whether the services need to be cached for subsequent connects, in order not to perform service discovery on each request. "cacheIdlepurge" defines how long the cache should be maintained before purging some devices support notifications on changes in services, "autoUpdate" allows the network to update services based on notification (on by default) "bonding" allows you to override the bonding method configured when onboarding the device Response: Success responses include a protocol mapping with an array of discovered properties, as defined in the specific protocol. For example, for BLE, this is an array of supported services, which in turn contains an array of charateristics, which in turn contains an array of descriptors, as shown in .

characteristics - charactericID - flags | |> Descriptors - descriptorID ]]>

Example of a response:

where- "id" is the id of the device "protocolMap" contains an Array of BLE services as shown in A failure will generate a standard failed response. Please refer to definition of failed response.

Update a connection Method: PUT /devices/{id}/manage/connection Description: Update cached ServiceMap for a device. Full service discovery will be performed, unless specific services are described in the API body. Parameters: id: the id of the device Request Body: A protocol map object. In the case of BLE, if no protocol map is included, service discovery is performed to discover all supported properties when connecting to a device. Optionally, service discovery may be limited to properties defined in the "ble" protocol extension. The services to be discovered can be added in an array. Property discover can be buffered across connections, so the API also supports caching parameters. Example body of an update connection:

where in the BLE protocol object: "services" is an array of services defined by their serviceIDs "cached" refers to whether the services need to be cached for subsequent connects, in order not to perform service discovery on each request "cacheIdlepurge" defines how long the cache should be maintained before purging some devices support notifications on changes in services, "autoUpdate" allows the network to update services based on notification (on by default) Response: Success responses include a protocol mapping with an array of discovered properties, as defined in the specific protocol. For example, for BLE, this is an array of supported services, which in turn contains an array of charateristics, which in turn contains an array of descriptors, as shown in . Example of a response:

where- "id" is the id of the device "protocolMap" contains an Array of BLE services as shown in A failure will generate a standard failed response. Please refer to definition of failed response.

Disconnect from a device Method: DELETE /devices/{id}/manage/connection Description: Disconnect from a device Parameters: id: the id of the device Response: Returns HTTP status code 200 OK with device ID on successful disconnect. Example of a response:

where "id" is the id of the device. A failure will generate a standard failed response. Please refer to definition of failed response.

Get connection status Method: GET /devices/{id}/manage/connection Description: Get connection status for a device. Success when device(s) is/are connected, includes service map for the device if available. Failure when a device is not connected. Parameters: id: the id of the device Response: Example of a response:

where- "id" is the id of the device "protocolMap" contains an Array of BLE services as shown in A failure will generate a standard failed response. Please refer to definition of failed response.

NIPC Extensibility NIPC is extensible in two ways: Protocol mapping: New protocol mapping can extend NIPC with support for new non-IP protocols API extensions: API extensions leverage compound statements of basic NIPC action APIs to simplify common operations for applications.

Protocol extensions As described in , NIPC supports mapping protocol specific properties to NIPC properties. BLE and Zigbee are used as examples, but protocol mapping is extensible to other protocols, so now non-IP protocols can be supported by NIPC without a schema change. The protocol objects need to be extended with the new protocol as well. Protocol objects will be extended as follows: Attribute Req Type Example ble T object an object with BLE-specific properties zigbee T object an object with Zigbee-specific properties newProtocol T object an object with newProtocol-specific props In the new protocol object, protocol specific properties can be added. Protocol mappings need to be IANA registered.

API extensions /extension The extension APIs allow for extensibility of the APIs, either IANA registered extensions or vendor-specific extensions. Extension APIs must leverage the basic NIPC defined APIs and combine them in compound statements in order to streamline application operation against devices, make operations more expediant and convenient in one API call. In principle they do not add any basic functionality. In the OpenAPI model below, we have defined a few example extensions. The extensions can contain long running operations, such as firmware updates, or other bulk operations that can be performed on a device. For long running operations, the extension API will return a 202 Accepted status code and a location header with the URL to check the status of the operation. The status of the operation can be checked by calling the status extension API with the same device ID. The status extension API will return a 200 OK status code when the operation is in progress. When the operation is complete, the status extension API will return a 303 See Other status code with a location header with the URL to check the status of the operation. The GET operation on the extension API will return a 200 OK status code with the actual response once the operation is complete.

NIPC Error Handling The error codes in the NIPC APIs use URI-based error type identifiers as defined in Problem Details for HTTP APIs. The error codes can be generic or specific to the API category. The error codes are organized into the following categories: Generic: Broadly applicable errors, including authorization, invalid identifiers, and generic failures. Property APIs: Errors related to property APIs (read/write). Event APIs: Errors related to event APIs (enable/disable). Protocol specific: Errors related to protocol-specific operations. Extension APIs: Errors related to extension APIs. The specific error codes are defined in the table below: Error Code Description Category nipc-invalid-id Invalid device ID or gateway doesn't recognize the ID Generic nipc-invalid-sdf-url Invalid SDF URL or SDF affordance not found Generic nipc-extension-operation-not-executed Operation was not executed since the previous operation failed Generic nipc-sdf-model-already-registered SDF model already registered Generic nipc-sdf-model-in-use SDF model in use Generic nipc-property-not-readable Property not readable Property APIs nipc-property-not-writable Property not writable Property APIs nipc-event-already-enabled Event already enabled Event APIs nipc-event-not-enabled Event not enabled Event APIs nipc-event-not-registered Event not registered for any data application Event APIs nipc-protocolmap-ble-already-connected Device already connected Protocol specific nipc-protocolmap-ble-no-connection No connection found for device Protocol specific nipc-protocolmap-ble-connection-timeout BLE connection timeout Protocol specific nipc-protocolmap-ble-bonding-failed BLE bonding failed Protocol specific nipc-protocolmap-ble-connection-failed BLE connection failed Protocol specific nipc-protocolmap-ble-service-discovery-failed BLE service discovery failed Protocol specific nipc-protocolmap-ble-invalid-service-or-characteristic Invalid BLE service or characteristic ID Protocol specific nipc-protocolmap-zigbee-connection-timeout Zigbee connection timeout Protocol specific nipc-protocolmap-zigbee-invalid-endpoint-or-cluster Invalid Zigbee endpoint or cluster ID Protocol specific nipc-extension-broadcast-invalid-data Invalid transmit data Transmit APIs nipc-extension-firmware-rollback Firmware rollback Extension APIs nipc-extension-firmware-update-failed Firmware update failed Extension APIs The appropriate HTTP status code is returned in the response.

Publish/Subscribe Interface The publish/subscribe interface, or data streaming interface, is an MQTT publishing interface. Pub/sub topics can be created and managed by means of the /registration/data-app API. In this memo, we propose the data format to be CBOR .

CDDL Definition We have a CDDL definition where we define the DataSubscription struct that will be used by all the messages published to the MQTT broker. The DataSubscription struct is a CBOR map that will contain the raw data in bytes and a timestamp of the data. Optionally, the message will also have a deviceID that corresponds to the SCIM ID of the device if the payload is associated to a known device. Other fields in the CDDL such as apMacAddress and rssi can be optionally included but these fields can expose the underlying network topology. Each message also has a subscription choice group that will define the type of data that is being published. Each MQTT message can be a collection of DataSubscription structs. This collection is represented as DataBatch in the CDDL.

CBOR Examples This section contains a few examples of the DataSubscription struct depicted in CBOR diagnostic notation.

Examples This section contains a few examples on how applications can leverage NIPC operations to communicate with BLE and Zigbee devices.

Property Read/Write In this example, we will connect to a device and read and write from a property. The sequence of operations for this are: Onboard a device using the SCIM Interface (out of scope of this memo) Register an SDF model for the device

Request Body: JSON object with the SDF model, from Read a property from the BLE device

Write to a property on the BLE device

Enabling an Event In this example, we will onboard a device, and setup an advertisement subscription event for that device. The sequence of operations for this are: Onboard a device and endpoint app using the SCIM Interface (out of scope of this memo) Register an SDF model for the device

Request Body: JSON object with the SDF model, from Register the data app with the event

Enable the advertisement event

Check the status of the event

Security Considerations

API authorization In order to enable a network wishing to offer NIPC ALG functions, the network administrator authorizes application(s) to perform operations on the Gateway. This happens out of band and may be accomplished by means of exchanging tokens or public keys. Authorization can be role-based. The 3 primary roles are: Onboarding: Authorize an onboarding application against a SCIM server co-located with the gateway. Control: Authorize applications that may control devices. Data: Authorize applications that may receive telemetry.
It is possible to further refine roles down to an API basis.

IANA Considerations This section provides guidance to the Internet Assigned Numbers Authority (IANA) regarding registration of values related to NIPC, in accordance with .

Protocol mapping

API extensions

Well-known URIs

Problem Details for HTTP APIs

&RFC7644; &I-D.ietf-scim-device-model; &RFC2119; &RFC8174; &I-D.ietf-asdf-sdf; &RFC9114; &RFC7159; &RFC8949; &RFC3986; &RFC8615; &RFC9457; &RFC8610; &RFC8126; Bluetooth SIG Connectivity Standards Alliance Bluetooth SIG

OpenAPI definition The following non-normative model is provide for convenience of the implementor.

file "openapi.yml" # yaml-language-server: $schema=https://json-schema.org/draft/2020-12/schema openapi: 3.0.3 info: title: Non IP Device Control (NIPC) API description: |- This API specifies RESTful application layer interface for gateways providing operations against non-IP devices. The described interface is extensible. The examples includes leverage Bluetooth Low Energy and Zigbee as they are commonly deployed. termsOfService: http://swagger.io/terms/ contact: email: bbrinckm@cisco.com license: name: TBD url: TBD version: 0.5.4 externalDocs: description: NIPC IETF draft url: https://datatracker.ietf.org/doc/draft-ietf-asdf-nipc/ servers: - url: "{gw_host}/nipc/draft-07" variables: gw_host: default: localhost description: Gateway Host tags: - name: NIPC property APIs description: |- APIs that allow apps to get and update device properties. If the underlying protocol requires connection management, it will be performed as part of the API call. - name: NIPC event APIs description: |- APIs that allow apps to enable or disable event reporting on devices. If the underlying protocol requires connection management, it will be performed as part of the API call. - name: NIPC action APIs description: |- APIs that perform actions on devices. - name: NIPC management APIs description: |- APIs that manage device connections. - name: NIPC registration APIs description: |- APIs that register sdf models or data applications paths: ### NIPC Property APIs /devices/{id}/properties: put: tags: - NIPC property APIs summary: Update a value of one or more properties on a device description: |- Write a value to a property or multiple properties to a device. If underlying protocol requires a connection to be set up, this API call will perform the necessary connection management. If a connection is already active for this device, the existing connection will be leveraged without modifying it. operationId: UpdateProperties parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 requestBody: content: application/json: schema: $ref: '#/components/schemas/PropertyValueArray' required: true responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/PropertyValueResponseArray' default: description: Error response content: application/problem+json: schema: $ref: '#/components/schemas/FailureResponse' get: tags: - NIPC property APIs summary: Read a value from one or multiple properties on a device description: |- Read a value to a property or multiple properties from a device. If underlying protocol requires a connection to be set up, this API call will perform the necessary connection management. If a connection is already active for this device, the existing connection will be leveraged without modifying it. operationId: GetProperties parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: propertyName in: query description: Properties to be read required: true allowReserved: true schema: type: array items: type: string example: "https://example.com/heartrate#/sdfObject/thermostat/sdfProperty/temperature" responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Id' - $ref: '#/components/schemas/PropertyValueResponseArray' default: description: Error response content: application/problem+json: schema: $ref: '#/components/schemas/FailureResponse' ### NIPC Event APIs /devices/{id}/events: post: tags: - NIPC event APIs summary: Enable an event on a specific device description: |- Enable an event on a specific device or for a group of devices. If the underlying protocol requires a connection to be set up, this API call will perform the necessary connection management. If a connection is already active for this device, the existing connection will be leveraged without modifying it. operationId: EnableEvent parameters: - name: id in: path description: device id or group id required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: eventName in: query description: event that needs to be enabled required: true allowReserved: true schema: type: string example: "https://example.com/heartrate#/sdfObject/healthsensor/sdfEvent/fallDetected" responses: '201': description: Success headers: Location: description: Location of the created event schema: type: string format: uri example: "/devices/{id}/events?instanceId={instanceId}" default: description: Error response content: application/problem+json: schema: $ref: '#/components/schemas/FailureResponse' delete: tags: - NIPC event APIs summary: Disable an event on a specific device description: |- Disable an event on a specific device or a group of devices. If the underlying protocol requires a connection to be set up, this API call will perform the necessary connection management. If a connection is already active for this device, the existing connection will be leveraged without modifying it. operationId: DisableEvent parameters: - name: id in: path description: device id or group id required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: instanceId in: query description: instance id of the event that needs to be disabled required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 responses: '204': description: Success, no content default: description: Error response content: application/problem+json: schema: $ref: '#/components/schemas/FailureResponse' get: tags: - NIPC event APIs summary: Get status of events on a device description: |- Get status of an event or multiple events on a specific device operationId: GetEvents parameters: - name: id in: path description: The ID of the device. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: instanceId in: query description: Instance ID of the events that need to be filtered required: false schema: type: array items: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/EventStatusResponseArray' default: description: Error response content: application/problem+json: schema: $ref: '#/components/schemas/FailureResponse' /groups/{id}/events: post: tags: - NIPC event APIs summary: Enable an event on a group of devices description: |- Enable an event on a group of devices. If the underlying protocol requires a connection to be set up, this API call will perform the necessary connection management. If a connection is already active for this device, the existing connection will be leveraged without modifying it. operationId: EnableGroupEvent parameters: - name: id in: path description: group id for which the event needs to be enabled required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: eventName in: query description: event that needs to be enabled required: true allowReserved: true schema: type: string example: "https://example.com/heartrate#/sdfObject/healthsensor/sdfEvent/fallDetected" responses: '201': description: Success, event enabled headers: Location: description: Location of the created event schema: type: string format: uri example: "/groups/{id}/events?instanceId={instanceId}" default: description: Error response content: application/problem+json: schema: $ref: '#/components/schemas/FailureResponse' delete: tags: - NIPC event APIs summary: Disable an event on a group of devices description: |- Disable an event on a group of devices. If the underlying protocol requires a connection to be set up, this API call will perform the necessary connection management. If a connection is already active for this device, the existing connection will be leveraged without modifying it. operationId: DisableGroupEvent parameters: - name: id in: path description: group id for which the event needs to be disabled required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: instanceId in: query description: instance id of the event that needs to be disabled required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 responses: '204': description: Success, no content default: description: Error response content: application/problem+json: schema: $ref: '#/components/schemas/FailureResponse' get: tags: - NIPC event APIs summary: Get status of events on a group of devices description: |- Get status of an event or multiple events on a group of devices. operationId: GetGroupEvents parameters: - name: id in: path description: group id of the SCIM group required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: instanceId in: query description: Instance IDs of the events that need to be filtered required: false schema: type: array items: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 responses: '200': description: Success, events retrieved content: application/json: schema: $ref: '#/components/schemas/EventStatusResponseArray' default: description: Error response content: application/problem+json: schema: $ref: '#/components/schemas/FailureResponse' ### NIPC action APIs /devices/{id}/actions: post: tags: - NIPC action APIs summary: Perform an action on a device description: |- Perform an action on a device. If the underlying protocol requires a connection to be set up, this API call will perform the necessary connection management. If a connection is already active for this device, the existing connection will be leveraged without modifying it. Id cannot be a group-id. operationId: ActionProperty parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: actionName in: query description: action that needs to be performed required: true allowReserved: true schema: type: string example: "https://example.com/heartrate#/sdfObject/healthsensor/sdfAction/start" requestBody: content: application/octet-stream: schema: type: string format: binary required: false responses: '202': description: Accepted, action is being performed headers: Location: description: Location of the action schema: type: string format: uri example: "/devices/{id}/actions?instanceId={instanceId}" default: description: Error response content: application/problem+json: schema: $ref: '#/components/schemas/FailureResponse' get: tags: - NIPC action APIs summary: Get status of an action on a device description: |- Get status of an action on a specific device or a group of devices. Success is action is active, failure if action not active. operationId: GetAction parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: instanceId in: query description: instance id of the action that needs to be checked required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 responses: '200': description: Success, action is active content: application/json: schema: $ref: '#/components/schemas/ActionResponse' default: description: Error response content: application/problem+json: schema: $ref: '#/components/schemas/FailureResponse' /devices/{id}/manage/connection: post: tags: - NIPC management APIs summary: Connect a device description: |- Connect a device. 3 retries by default, optionally retry policy can be defined in the API body. If the protocol requires service discovery, full service discovery will be performed, unless specific services are described in the API body. operationId: ActionCreateConnection parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 requestBody: content: application/json: schema: anyOf: - $ref: '#/components/schemas/Connection' - $ref: './protocolmaps/ProtocolMap.yaml#/components/schemas/ProtocolMap-ServiceList' required: false responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Id' - $ref: './protocolmaps/ProtocolMap.yaml#/components/schemas/ProtocolMap-ServiceMap' default: description: Error response content: application/problem+json: schema: $ref: '#/components/schemas/FailureResponse' put: tags: - NIPC management APIs summary: Update cached ServiceMap for a device. description: |- Update cached ServiceMap for a device. Full service discovery will be performed, unless specific services are described in the API body. operationId: ActionUpdateServiceMap parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 requestBody: content: application/json: schema: $ref: './protocolmaps/ProtocolMap.yaml#/components/schemas/ProtocolMap-ServiceList' required: false responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Id' - $ref: './protocolmaps/ProtocolMap.yaml#/components/schemas/ProtocolMap-ServiceMap' default: description: Error response content: application/problem+json: schema: $ref: '#/components/schemas/FailureResponse' delete: tags: - NIPC management APIs summary: Disconnect a device description: |- Disconnect a device. operationId: ActionDeleteConnection parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Id' default: description: Error response content: application/problem+json: schema: $ref: '#/components/schemas/FailureResponse' get: tags: - NIPC management APIs summary: Get connection state for a device description: |- Get connection status for a device. Success when device(s) is/are connected, includes service map for the device if available. Failure when a device is not connected operationId: ActionGetConnection parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Id' - $ref: './protocolmaps/ProtocolMap.yaml#/components/schemas/ProtocolMap-ServiceMap' default: description: Error response content: application/problem+json: schema: $ref: '#/components/schemas/FailureResponse' ### Registrations /registration/model: post: tags: - NIPC registration APIs summary: Register an sdfObject description: |- Register an sdfObject, including Properties, Events and actions operationId: registerSdfObject requestBody: content: application/sdf+json: schema: $ref: '#/components/schemas/SdfModel' required: true responses: '200': description: Success content: application/json: schema: type: array items: allOf: - $ref: '#/components/schemas/SdfReference' default: description: Error response content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/FailureResponse' get: tags: - NIPC registration APIs summary: Get all registered SDF model names description: |- Get all registered SDF model names. operationId: getSdfRefs parameters: - name: sdfName in: query description: sdfName can be a reference to an sdfThing or sdfObject required: false allowReserved: true schema: type: string example: "https://example.com/heartrate#/sdfObject/healthsensor" responses: '200': description: Success content: application/sdf+json: schema: $ref: '#/components/schemas/SdfModel' default: description: Error response content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/FailureResponse' put: tags: - NIPC registration APIs summary: Update an SDF model description: |- Update an SDF model, including Properties, Events and actions operationId: updateSdf parameters: - name: sdfName in: query description: sdfName can be a reference to an sdfThing or sdfObject required: true allowReserved: true schema: type: string example: "https://example.com/heartrate#/sdfObject/healthsensor" requestBody: content: application/sdf+json: schema: $ref: '#/components/schemas/SdfModel' required: true responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/SdfReference' default: description: Error response content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/FailureResponse' delete: tags: - NIPC registration APIs summary: Delete an sdfObject description: |- Delete an sdfObject, including Properties, Events and actions operationId: deleteSdfObject parameters: - name: sdfName in: path description: sdfObject name required: true schema: type: string example: "https://example.com/heartrate#/sdfObject/healthsensor" responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/SdfReference' default: description: Error response content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/FailureResponse' /registration/data-app: post: tags: - NIPC registration APIs summary: Register a dataApp description: |- Register a dataApp that is able to receive device data. operationId: registerDataApp parameters: - name: dataAppId in: query description: id of the data app that will be registered required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 requestBody: content: application/json: schema: $ref: '#/components/schemas/DataApp' required: true responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/DataApp' default: description: Error response content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/FailureResponse' put: tags: - NIPC registration APIs summary: Update registration of a dataApp description: |- Update registration of a dataApp that is able to receive device data. operationId: UpdateDataApp parameters: - name: dataAppId in: path description: id of the data app that will be updated required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 requestBody: content: application/json: schema: $ref: '#/components/schemas/DataApp' required: true responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/DataApp' default: description: Error response content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/FailureResponse' delete: tags: - NIPC registration APIs summary: Delete registration of a dataApp description: |- Delete registration of a dataApp that is able to receive device data. operationId: DeleteDataApp parameters: - name: dataAppId in: path description: id of the data app that will be updated required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/DataApp' default: description: Error response content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/FailureResponse' get: tags: - NIPC registration APIs summary: Get registration of a dataApp description: |- Get registrationdetails of a dataApp that is able to receive device data. operationId: GetDataApp parameters: - name: dataAppId in: query description: id of the data app that will be updated required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/DataApp' default: description: Error response content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/FailureResponse' components: schemas: # Base objects ## A SCIM id, can be a device or a group Id: required: - id type: object properties: id: type: string format: uuid description: A SCIM-generated UUID, can be a device or group example: 12345678-1234-5678-1234-56789abcdef4 ## A property Property: required: - property type: object properties: property: type: string example: "https://example.com/heartrate#/sdfObject/thermostat/sdfProperty/temperature" ActionResponse: required: - action type: object properties: status: type: string example: COMPLETED description: Status of the action, can be IN_PROGRESS or COMPLETED ## A value Value: required: - value type: object properties: value: type: string format: byte example: dGVzdA== ## A value of an property of an Device PropertyValue: allOf: - $ref: '#/components/schemas/Property' - $ref: '#/components/schemas/Value' ## An array of Property values PropertyValueArray: type: array items: $ref: '#/components/schemas/PropertyValue' ## Event Event: required: - event type: object properties: event: type: string description: percent-encoded JSON pointer to the SDF event object example: https://example.com/heartrate#/sdfObject/healthsensor/sdfEvent/fallDetected InstanceId: type: object properties: instanceId: type: string format: uuid description: A SCIM-generated UUID for the event instance example: 12345678-1234-5678-1234-56789abcdef4 ## A Connection Connection: type: object properties: retries: type: integer format: int32 example: 3 retryMultipleAPs: type: boolean example: true ## DataApp DataApp: oneOf: - $ref: '#/components/schemas/DataAppMqttClient' - $ref: '#/components/schemas/DataAppMqttBroker' - $ref: '#/components/schemas/DataAppWebhook' - $ref: '#/components/schemas/DataAppWebsocket' type: object properties: events: type: array items: $ref: '#/components/schemas/Event' DataAppMqttClient: type: object properties: mqttClient: type: object DataAppMqttBroker: type: object properties: mqttBroker: type: object required: - URI - username - password properties: URI: type: string example: mqtt.broker.com:8883 username: type: string example: user1 password: type: string example: password1 brokerCACert: description: PEM encoded CA certificate type: string customTopic: type: string description: custom MQTT topic to publish to example: custom/topic DataAppWebhook: type: object properties: webhook: type: object properties: URI: type: string example: webhook.com:443 headers: type: object additionalProperties: type: string example: x-api-key: fjelk-3dl33f-2wdsd serverCACert: type: string DataAppWebsocket: type: object properties: websocket: type: object properties: URI: type: string example: websocket.com:443 headers: type: object additionalProperties: type: string example: x-api-key: fjelk-3dl33f-2wdsd serverCACert: type: string ## sdfObject registration definition SdfReference: type: object description: SDF URL referring to the sdfobject properties: sdfName: type: string example: "https://example.com/heartrate#/sdfObject/healthsensor" SdfModel: allOf: - type: object description: Sample SDF model properties: namespace: type: object additionalProperties: type: string example: heartrate: https://example.com/heartrate defaultNamespace: type: string example: heartrate - oneOf: - $ref: '#/components/schemas/SdfThing' - $ref: '#/components/schemas/SdfObject' SdfThing: type: object description: Sample SDF thing properties: sdfThing: additionalProperties: anyOf: - $ref: '#/components/schemas/SdfProperty' - $ref: '#/components/schemas/SdfEvent' - $ref: '#/components/schemas/SdfAction' - $ref: '#/components/schemas/SdfObject' example: multipleSensor: sdfEvent: isPresent: sdfOutputData: protocolMap: ble: type: advertisement sdfObject: healthsensor: sdfProperty: heartrate: protocolMap: ble: serviceID: 12345678-1234-5678-1234-56789abcdef4 characteristicID: 12345678-1234-5678-1234-56789abcdef4 sdfEvent: fallDetected: sdfOutputData: protocolMap: ble: serviceID: 12345678-1234-5678-1234-56789abcdef4 characteristicID: 12345678-1234-5678-1234-56789abcdef4 sdfAction: start: protocolMap: ble: serviceID: 12345678-1234-5678-1234-56789abcdef4 characteristicID: 12345678-1234-5678-1234-56789abcdef4 SdfObject: type: object description: Sample SDF object properties: sdfObject: additionalProperties: anyOf: - $ref: '#/components/schemas/SdfProperty' - $ref: '#/components/schemas/SdfEvent' - $ref: '#/components/schemas/SdfAction' example: healthsensor: sdfProperty: heartrate: protocolMap: ble: serviceID: 12345678-1234-5678-1234-56789abcdef4 characteristicID: 12345678-1234-5678-1234-56789abcdef4 sdfEvent: fallDetected: sdfOutputData: protocolMap: ble: serviceID: 12345678-1234-5678-1234-56789abcdef4 characteristicID: 12345678-1234-5678-1234-56789abcdef4 sdfAction: start: protocolMap: ble: serviceID: 12345678-1234-5678-1234-56789abcdef4 characteristicID: 12345678-1234-5678-1234-56789abcdef4 SdfProperty: type: object description: Sample SDF property properties: sdfProperty: additionalProperties: allOf: - $ref: './protocolmaps/ProtocolMap.yaml#/components/schemas/ProtocolMap-Property' example: heartrate: protocolMap: ble: serviceID: 12345678-1234-5678-1234-56789abcdef4 characteristicID: 12345678-1234-5678-1234-56789abcdef4 SdfEvent: type: object description: Sample SDF property properties: sdfEvent: additionalProperties: #example, this will be the registered event type: object properties: sdfOutputData: allOf: - $ref: './protocolmaps/ProtocolMap.yaml#/components/schemas/ProtocolMap-Event' example: fallDetected: sdfOutputData: protocolMap: ble: serviceID: 12345678-1234-5678-1234-56789abcdef4 characteristicID: 12345678-1234-5678-1234-56789abcdef4 SdfAction: type: object description: Sample SDF property properties: sdfAction: additionalProperties: allOf: - $ref: './protocolmaps/ProtocolMap.yaml#/components/schemas/ProtocolMap-Property' example: start: protocolMap: ble: serviceID: 12345678-1234-5678-1234-56789abcdef4 characteristicID: 12345678-1234-5678-1234-56789abcdef4 # responses SuccessResponse: type: object properties: status: type: integer format: int32 example: 200 description: HTTP status code ## Error 500 application Failure response FailureResponse: type: object properties: type: type: string description: URI to the error type enum: - https://www.iana.org/assignments/http-problem-types#nipc-invalid-id - https://www.iana.org/assignments/http-problem-types#nipc-invalid-sdf-url - https://www.iana.org/assignments/http-problem-types#nipc-extension-operation-not-executed - https://www.iana.org/assignments/http-problem-types#nipc-sdf-model-already-registered - https://www.iana.org/assignments/http-problem-types#nipc-sdf-model-in-use - https://www.iana.org/assignments/http-problem-types#nipc-property-not-readable - https://www.iana.org/assignments/http-problem-types#nipc-property-not-writable - https://www.iana.org/assignments/http-problem-types#nipc-event-already-enabled - https://www.iana.org/assignments/http-problem-types#nipc-event-not-enabled - https://www.iana.org/assignments/http-problem-types#nipc-event-not-registered - https://www.iana.org/assignments/http-problem-types#nipc-protocolmap-ble-already-connected - https://www.iana.org/assignments/http-problem-types#nipc-protocolmap-ble-no-connection - https://www.iana.org/assignments/http-problem-types#nipc-protocolmap-ble-connection-timeout - https://www.iana.org/assignments/http-problem-types#nipc-protocolmap-ble-bonding-failed - https://www.iana.org/assignments/http-problem-types#nipc-protocolmap-ble-connection-failed - https://www.iana.org/assignments/http-problem-types#nipc-protocolmap-ble-service-discovery-failed - https://www.iana.org/assignments/http-problem-types#nipc-protocolmap-ble-invalid-service-or-characteristic - https://www.iana.org/assignments/http-problem-types#nipc-protocolmap-zigbee-connection-timeout - https://www.iana.org/assignments/http-problem-types#nipc-protocolmap-zigbee-invalid-endpoint-or-cluster - https://www.iana.org/assignments/http-problem-types#nipc-extension-broadcast-invalid-data - https://www.iana.org/assignments/http-problem-types#nipc-extension-firmware-rollback - https://www.iana.org/assignments/http-problem-types#nipc-extension-firmware-update-failed - about:blank status: type: integer format: int32 example: 400 description: HTTP status code title: type: string example: Invalid Device ID description: Human-readable error title detail: type: string example: Device ID 12345678-1234-5678-1234-56789abcdef4 does not exist or is not a device description: Human-readable error message ## Property operations responses PropertyValueResponseArrayItem: oneOf: - $ref: '#/components/schemas/SuccessResponse' - $ref: '#/components/schemas/FailureResponse' PropertyValueResponseArray: type: array items: $ref: '#/components/schemas/PropertyValueResponseArrayItem' ## Event operations responses EventStatusResponseArrayItem: oneOf: - allOf: - $ref: '#/components/schemas/Event' - $ref: '#/components/schemas/InstanceId' - $ref: '#/components/schemas/FailureResponse' EventStatusResponseArray: type: array items: $ref: '#/components/schemas/EventStatusResponseArrayItem' ]]>

Protocol mapping NIPC requires that a protocol mapping be provided as part of the sdf model for a device or have one provided using the NIPC action APIs with embedded protocol mapping. The protocol mapping is a JSON object that describes the underlying technology used to communicate with the device along with any additional information needed to communicate with the device. The JSON format of the protocol mapping is provided as a non-normative OpenAPI model for the convenience of the implementor.

Protocol mapping OpenAPI model

file "ProtocolMap.yaml" openapi: 3.0.3 info: title: Non IP Device Control (NIPC) Protocol Mapping description: |- Non IP Device Control (NIPC) Protocol Mapping. When adding a new protocol mapping pls add a reference to the protocol map for all the schemas in this file. termsOfService: http://swagger.io/terms/ contact: email: bbrinckm@cisco.com license: name: TBD url: TBD version: 0.5.4 externalDocs: description: NIPC IETF draft url: https://datatracker.ietf.org/doc/draft-ietf-asdf-nipc/ components: schemas: # Protocol Mapping ## Protocol Map for Service Discovery ProtocolMap-ServiceList: type: object properties: protocolMap: oneOf: - $ref: './ProtocolMap-BLE.yaml#/components/schemas/ProtocolMap-BLE-ServiceList' ## Protocol Map for Service Discovery result ProtocolMap-ServiceMap: type: object properties: protocolMap: oneOf: - $ref: './ProtocolMap-BLE.yaml#/components/schemas/ProtocolMap-BLE-ServiceMap' - $ref: './ProtocolMap-Zigbee.yaml#/components/schemas/ProtocolMap-Zigbee-ServiceMap' ## Protocol Map for Error Codes ProtocolMap-ErrorCodes: type: object properties: protocolMap: oneOf: - $ref: './ProtocolMap-BLE.yaml#/components/schemas/ProtocolMap-BLE-ErrorCodes' - $ref: './ProtocolMap-Zigbee.yaml#/components/schemas/ProtocolMap-Zigbee-ErrorCodes' ## Protocol Map for Broadcasts ProtocolMap-Broadcast: type: object properties: protocolMap: oneOf: - $ref: './ProtocolMap-BLE.yaml#/components/schemas/ProtocolMap-BLE-Broadcast' - $ref: './ProtocolMap-Zigbee.yaml#/components/schemas/ProtocolMap-Zigbee-Broadcast' ## Protocol Map for a property ProtocolMap-Property: type: object properties: protocolMap: oneOf: - $ref: './ProtocolMap-BLE.yaml#/components/schemas/ProtocolMap-BLE-Propmap' - $ref: './ProtocolMap-Zigbee.yaml#/components/schemas/ProtocolMap-Zigbee-Propmap' ## Protocol Map for an event ProtocolMap-Event: type: object properties: protocolMap: oneOf: - $ref: './ProtocolMap-BLE.yaml#/components/schemas/ProtocolMap-BLE-Event' - $ref: './ProtocolMap-Zigbee.yaml#/components/schemas/ProtocolMap-Zigbee-Event' ]]>

Protocol map for BLE

file "ProtocolMap-BLE.yaml" openapi: 3.0.3 info: title: Non IP Device Control (NIPC) BLE Protocol Mapping description: |- Non IP Device Control (NIPC) BLE Protocol Mapping. termsOfService: http://swagger.io/terms/ contact: email: bbrinckm@cisco.com license: name: TBD url: TBD version: 0.5.4 externalDocs: description: NIPC IETF draft url: https://datatracker.ietf.org/doc/draft-ietf-asdf-nipc/ components: schemas: # BLE Protocol Mapping ## A Service is a device with optional service IDs ProtocolMap-BLE-ServiceList: type: object properties: ble: type: object properties: services: type: array items: type: object properties: serviceID: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 cached: description: |- If we can cache information, then device doesn't need to be rediscovered before every connected. type: boolean default: false cacheIdlePurge: description: cache expiry period, when device allows type: integer example: 3600 # default 1 hour autoUpdate: description: |- autoupdate services if device supports it (default) type: boolean example: true bonding: #optional, by default defined in SCIM object type: string example: default enum: - default - none - justworks - passkey - oob ## Protocol Mapping for BLE Service Map ProtocolMap-BLE-ServiceMap: required: - services type: object properties: ble: type: array items: $ref: '#/components/schemas/ProtocolMap-BLE-Service' ProtocolMap-BLE-Service: required: - serviceID - characteristics type: object properties: serviceID: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 characteristics: type: array items: $ref: '#/components/schemas/ProtocolMap-BLE-Characteristic' ProtocolMap-BLE-Characteristic: required: - characteristicID - flags - descriptors type: object properties: characteristicID: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 flags: type: array example: - read - write items: type: string enum: - read - write - notify descriptors: type: array items: $ref: '#/components/schemas/ProtocolMap-BLE-Descriptor' ProtocolMap-BLE-Descriptor: required: - descriptorID type: object properties: descriptorID: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 ## Protocol Mapping for BLE Broadcast ProtocolMap-BLE-Broadcast: required: - ble type: object properties: ble: type: object ## Protocol Mapping for BLE Property ProtocolMap-BLE-Propmap: required: - ble type: object properties: ble: required: - serviceID - characteristicID type: object properties: serviceID: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 characteristicID: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 ## Defines different types of BLE events ProtocolMap-BLE-Event: required: - ble type: object properties: ble: required: - type type: object properties: type: type: string example: gatt enum: - gatt - connection_events - advertisements serviceID: type: string example: 12345678-1234-5678-1234-56789abcdef0 characteristicID: type: string example: 12345678-1234-5678-1234-56789abcdef1 ## BLE Error codes ProtocolMap-BLE-ErrorCodes: type: object properties: nipcStatus: type: integer format: int32 enum: - 1011 # BLE bonding failed - 1013 # BLE service discovery failed ]]>

Protocol map for Zigbee

file "ProtocolMap-Zigbee.yaml" openapi: 3.0.3 info: title: Non IP Device Control (NIPC) Zigbee Protocol Mapping description: |- Non IP Device Control (NIPC) Zigbee Protocol Mapping. termsOfService: http://swagger.io/terms/ contact: email: bbrinckm@cisco.com license: name: TBD url: TBD version: 0.5.4 externalDocs: description: NIPC IETF draft url: https://datatracker.ietf.org/doc/draft-ietf-asdf-nipc/ components: schemas: # Zigbee Protocol Mapping ## Protocol Mapping for Zigbee Service Map ProtocolMap-Zigbee-ServiceMap: required: - zigbee type: object properties: zigbee: type: array items: $ref: '#/components/schemas/ProtocolMap-Zigbee-Endpoint' ProtocolMap-Zigbee-Endpoint: required: - endpointID - clusters type: object properties: endpointID: type: integer format: int32 example: 10 clusters: type: array items: $ref: '#/components/schemas/ProtocolMap-Zigbee-Cluster' ProtocolMap-Zigbee-Cluster: required: - clusterID - properties type: object properties: clusterID: type: integer format: int32 example: 0 properties: type: array items: $ref: '#/components/schemas/ProtocolMap-Zigbee-Property' ProtocolMap-Zigbee-Property: required: - propertyID - propertyType type: object properties: propertyID: type: integer format: int32 example: 1 propertyType: type: integer format: int32 example: 32 ## Protocol Mapping for Zigbee broadcast ProtocolMap-Zigbee-Broadcast: required: - zigbee type: object properties: zigbee: type: object ## Protocol mapping for Zigbee property ProtocolMap-Zigbee-Propmap: required: - zigbee type: object properties: zigbee: required: - endpointID - clusterID - propertyID type: object properties: endpointID: type: integer format: int32 example: 1 clusterID: type: integer format: int32 example: 6 propertyID: type: integer format: int32 example: 16 type: type: integer format: int32 example: 1 ProtocolMap-Zigbee-Event: allOf: - $ref: '#/components/schemas/ProtocolMap-Zigbee-Propmap' ## Zigbee Error codes ProtocolMap-Zigbee-ErrorCodes: type: object properties: nipcStatus: type: integer format: int32 enum: - 1021 # Zigbee join failed ]]>

NIPC API extensions The following OpenAPI models define a few example extensions to the NIPC API.

NIPC API write binary blob extension

file "Extension-Blob.yaml" # yaml-language-server: $schema=https://json-schema.org/draft/2020-12/schema openapi: 3.0.3 info: title: Non IP Device Control (NIPC) API write binary blob extension description: |- Non IP Device Control (NIPC) API write binary blob extension termsOfService: http://swagger.io/terms/ contact: email: bbrinckm@cisco.com license: name: TBD url: TBD version: 0.5.4 externalDocs: description: NIPC IETF draft url: https://datatracker.ietf.org/doc/draft-ietf-asdf-nipc/ servers: - url: "{gw_host}/nipc/draft-07" variables: gw_host: default: localhost description: Gateway Host tags: - name: NIPC API extensions description: |- APIs that simplify application interaction by implementing one or more basic APIs into a single API call. paths: ### Extensions /extensions/{id}/properties/{propertyName}/blob: put: tags: - NIPC API extensions summary: Write a binary blob to a property on a device description: |- Write a binary blob to a property on a device. Will chunk up the binary blob and perform multiple writes. If the underlying protocol requires a connection to be set up, this API call will perform the necessary connection management. If a connection is already active for this device, the existing connection will be leveraged without modifying it. Id cannot be a group-id. operationId: writeBlob parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: propertyName in: path description: The SDF property name that needs to be written to. required: true schema: type: string example: "bin_blob" requestBody: content: application/json: schema: $ref: '#/components/schemas/Extension-Blob' required: true responses: '204': description: Success, no content 'default': description: Error response content: application/json: schema: $ref: '../NIPC.yaml#/components/schemas/FailureResponse' components: schemas: # Extensions ## A binary blob Extension Extension-Blob: required: - blob type: object properties: blob: type: string format: byte chunksize: type: integer ]]>

NIPC API bulk operations extension

file "Extension-Bulk.yaml" # yaml-language-server: $schema=https://json-schema.org/draft/2020-12/schema openapi: 3.0.3 info: title: Non IP Device Control (NIPC) API bulk extension description: |- Non IP Device Control (NIPC) API bulk extension termsOfService: http://swagger.io/terms/ contact: email: bbrinckm@cisco.com license: name: TBD url: TBD version: 0.5.4 externalDocs: description: NIPC IETF draft url: https://datatracker.ietf.org/doc/draft-ietf-asdf-nipc/ servers: - url: "{gw_host}/nipc/draft-07" variables: gw_host: default: localhost description: Gateway Host tags: - name: NIPC API extensions description: |- APIs that simplify application interaction by implementing one or more basic APIs into a single API call. paths: ### Extensions /extensions/{id}/bulk: post: tags: - NIPC API extensions summary: Compound operations on a device description: Compound operations on a device operationId: Bulk parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 requestBody: content: application/json: schema: $ref: '#/components/schemas/Extension-Bulk' examples: bulkRequest: $ref: '#/components/examples/bulkRequest' required: true responses: '202': description: Accepted headers: Location: schema: type: string description: URL to get the bulk status response example: /extensions/12345678-1234-5678-1234-56789abcdef4/bulk/status?requestId=12345678-1234-5678-1234-56789abcdef4 '401': description: Unauthorized '405': description: Invalid request '500': description: Server-side failure content: application/json: schema: $ref: '../NIPC.yaml#/components/schemas/FailureResponse' callbacks: bulkEvent: '{$request.body#/callback.url}': post: description: Callback for bulk response operationId: bulkCallback requestBody: content: application/json: schema: allOf: - $ref: '../NIPC.yaml#/components/schemas/Id' - $ref: '#/components/schemas/Extension-BulkResponse' responses: '200': description: OK '400': description: Bad request '401': description: Unauthorized '405': description: Invalid request '500': description: Server-side failure get: tags: - NIPC API extensions summary: Get Bulk response description: Get Bulk response operationId: getBulkResponse parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: requestId in: query description: Request ID of the bulk operation required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 responses: '200': description: OK headers: content: application/json: schema: allOf: - $ref: '../NIPC.yaml#/components/schemas/Id' - $ref: '#/components/schemas/Extension-BulkResponse' examples: bulkResponse: $ref: '#/components/examples/bulkResponse' errorBulkResponse: $ref: '#/components/examples/errorBulkResponse' /extensions/{id}/bulk/status: get: tags: - NIPC API extensions summary: Get Bulk status description: Get Bulk status operationId: getBulkStatus parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: requestId in: query description: Request ID of the bulk operation required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 responses: '200': description: OK headers: content: application/json: schema: allOf: - $ref: './Extension-ReadConditional.yaml#/components/schemas/Extension-StatusResponse' '303': description: See Other headers: Location: schema: type: string description: URL to get the bulk response example: /extensions/12345678-1234-5678-1234-56789abcdef4/bulk?requestId=12345678-1234-5678-1234-56789abcdef4 content: application/json: schema: allOf: - $ref: './Extension-ReadConditional.yaml#/components/schemas/Extension-StatusResponse' examples: successExample: summary: Success value: status: COMPLETED components: schemas: # Extensions ## Bulk schema Extension Extension-Bulk: allOf: - $ref: './Extension-ReadConditional.yaml#/components/schemas/Extension-Callback' - type: object properties: operations: type: array items: $ref: '#/components/schemas/Extension-BulkOperation' ## Extension that defines an operation in a bulk API Extension-BulkOperation: required: - method - path allOf: - type: object properties: method: type: string enum: - POST - PUT - GET path: type: string enum: - /devices/{id}/properties?propertyName={propertyName} - /devices/{id}/actions/?actionName={actionName} - /extensions/{id}/properties/read/conditional?propertyName={propertyName} example: /devices/12345678-1234-5678-1234-56789abcdef4/properties?propertyName=https://example.com/thermometer%23/sdfThing/thermometer/sdfProperty/temperature data: type: object oneOf: - $ref: '../NIPC.yaml#/components/schemas/Value' - $ref: './Extension-ReadConditional.yaml#/components/schemas/Extension-ConditionalRead' ## Multiple returns for a bulk operation Extension-BulkResponse: type: object properties: operations: type: array items: $ref: '#/components/schemas/Extension-OperationResponse' ## Return for an operation Extension-OperationResponse: allOf: - type: object properties: method: type: string enum: - POST - PUT - GET path: type: string enum: - /devices/{id}/properties?propertyName={propertyName} - /devices/{id}/actions/?actionName={actionName} - /extensions/{id}/properties/read/conditional?propertyName={propertyName} example: /devices/12345678-1234-5678-1234-56789abcdef4/properties?propertyName=https://example.com/thermometer%23/sdfThing/thermometer/sdfProperty/temperature response: anyOf: - $ref: '../NIPC.yaml#/components/schemas/Value' - $ref: '../NIPC.yaml#/components/schemas/SuccessResponse' - $ref: '../NIPC.yaml#/components/schemas/FailureResponse' examples: bulkRequest: summary: Bulk request example value: operations: - method: GET path: /devices/12345678-1234-5678-1234-56789abcdef4/properties?propertyName=https://example.com/thermometer%23/sdfThing/thermometer/sdfProperty/temperature - method: PUT path: /devices/12345678-1234-5678-1234-56789abcdef4/properties?propertyName=https://example.com/thermometer%23/sdfThing/thermometer/sdfProperty/temperature data: value: dGVzdA== - method: POST path: /extensions/12345678-1234-5678-1234-56789abcdef4/properties/read/conditional?propertyName=https://example.com/thermometer%23/sdfThing/thermometer/sdfProperty/temperature data: value: dGVzdA== maxRepeat: 5 retryTime: 1 bulkResponse: summary: Bulk response example value: operations: - method: GET path: /devices/12345678-1234-5678-1234-56789abcdef4/properties?propertyName=https://example.com/thermometer%23/sdfThing/thermometer/sdfProperty/temperature response: value: dGVzdA== - method: PUT path: /devices/12345678-1234-5678-1234-56789abcdef4/properties?propertyName=https://example.com/thermometer%23/sdfThing/thermometer/sdfProperty/temperature response: status: 200 - method: POST path: /extensions/12345678-1234-5678-1234-56789abcdef4/properties/read/conditional?propertyName=https://example.com/thermometer%23/sdfThing/thermometer/sdfProperty/temperature response: value: dGVzdA== errorBulkResponse: summary: Error Bulk response example value: operations: - method: GET path: /devices/12345678-1234-5678-1234-56789abcdef4/properties?propertyName=https://example.com/thermometer%23/sdfThing/thermometer/sdfProperty/temperature response: type: https://www.iana.org/assignments/http-problem-types#nipc-property-not-readable status: 400 title: Property not readable detail: Property https://example.com/thermometer#/sdfThing/thermometer/sdfProperty/temperature is not readable - method: PUT path: /devices/12345678-1234-5678-1234-56789abcdef4/properties?propertyName=https://example.com/thermometer%23/sdfThing/thermometer/sdfProperty/temperature response: type: https://www.iana.org/assignments/http-problem-types#nipc-extension-operation-not-executed status: 400 title: Operation not executed detail: Operation was not executed since the previous operation failed - method: POST path: /extensions/12345678-1234-5678-1234-56789abcdef4/properties/read/conditional?propertyName=https://example.com/thermometer%23/sdfThing/thermometer/sdfProperty/temperature response: type: https://www.iana.org/assignments/http-problem-types#nipc-extension-operation-not-executed status: 400 title: Operation not executed detail: Operation was not executed since the previous operation failed ]]>

NIPC API write file extension

file "Extension-File.yaml" # yaml-language-server: $schema=https://json-schema.org/draft/2020-12/schema openapi: 3.0.3 info: title: Non IP Device Control (NIPC) API write file extension description: |- Non IP Device Control (NIPC) API write file extension termsOfService: http://swagger.io/terms/ contact: email: bbrinckm@cisco.com license: name: TBD url: TBD version: 0.5.4 externalDocs: description: NIPC IETF draft url: https://datatracker.ietf.org/doc/draft-ietf-asdf-nipc/ servers: - url: "{gw_host}/nipc/draft-07" variables: gw_host: default: localhost description: Gateway Host tags: - name: NIPC API extensions description: |- APIs that simplify application interaction by implementing one or more basic APIs into a single API call. paths: ### Extensions /extensions/{id}/properties/{propertyName}/file: put: tags: - NIPC API extensions summary: Write a file to a property on a device description: |- Write a file to a property on a device. Will chunk up the file and perform multiple writes. If the underlying protocol requires a connection to be set up, this API call will perform the necessary connection management. If a connection is already active for this device, the existing connection will be leveraged without modifying it. Id cannot be a group-id. operationId: writeFile parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: propertyName in: path description: The SDF property name that needs to be written to. required: true schema: type: string example: "firmware" requestBody: content: application/json: schema: $ref: '#/components/schemas/Extension-File' required: true responses: '204': description: Success, no content 'default': description: Error response content: application/json: schema: $ref: '../NIPC.yaml#/components/schemas/FailureResponse' components: schemas: # Extensions ## A File Extension Extension-File: required: - fileURL type: object properties: fileURL: type: string example: "https://domain.com/firmware.dat" chunksize: type: integer ]]>

NIPC API firmware update extension

file "Extension-Firmware.yaml" # yaml-language-server: $schema=https://json-schema.org/draft/2020-12/schema openapi: 3.0.3 info: title: Non IP Device Control (NIPC) API firmware upgrade extension description: |- Non IP Device Control (NIPC) API firmware upgrade extension, requires the file extension termsOfService: http://swagger.io/terms/ contact: email: bbrinckm@cisco.com license: name: TBD url: TBD version: 0.5.4 externalDocs: description: NIPC IETF draft url: https://datatracker.ietf.org/doc/draft-ietf-asdf-nipc/ servers: - url: "{gw_host}/nipc/draft-07" variables: gw_host: default: localhost description: Gateway Host tags: - name: NIPC API extensions description: |- APIs that simplify application interaction by implementing one or more basic APIs into a single API call. paths: ### Extensions /extensions/{id}/firmware: put: tags: - NIPC API extensions summary: Upgrade the firmware of a device description: |- Update the firmware of a device. Will perform all operations required to upgrade the firmware. Id cannot be a group-id. operationId: upgradeFirmware parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 requestBody: content: application/json: schema: allOf: - $ref: './Extension-File.yaml#/components/schemas/Extension-File' - $ref: '#/components/schemas/Extension-Firmware' - $ref: './Extension-ReadConditional.yaml#/components/schemas/Extension-Callback' required: true responses: '202': description: Accepted headers: Location: schema: type: string description: Location of the resource example: /12345678-1234-5678-1234-56789abcdef4/extension/firmware/status?requestId=12345678-1234-5678-1234-56789abcdef4 default: description: Error response content: application/json: schema: $ref: '../NIPC.yaml#/components/schemas/FailureResponse' callbacks: bulkEvent: '{$request.body#/callback.url}': post: description: Callback for bulk response operationId: bulkCallback requestBody: content: application/json: schema: anyOf: - $ref: '../NIPC.yaml#/components/schemas/Id' - allOf: - $ref: '../NIPC.yaml#/components/schemas/FailureResponse' - $ref: '#/components/schemas/ExtensionErrorCodes' responses: '200': description: OK '400': description: Bad request '401': description: Unauthorized '405': description: Invalid request '500': description: Server-side failure get: tags: - NIPC API extensions summary: Get the status of a firmware upgrade of a device description: |- Get the status of a firmware upgrade of a device. Returns success when ongoing or completed, with a reason. Returns failure when upgrade has failed. Id cannot be a group-id. operationId: upgradeFirmwareStatus parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: requestId in: query description: Request ID of the firmware upgrade operation required: true schema: type: string example: 12345678-1234-5678-1234-56789abcdef4 responses: '200': description: OK headers: Location: schema: type: string description: Location of the resource content: application/json: schema: $ref: '../NIPC.yaml#/components/schemas/Id' '400': description: Bad request '401': description: Unauthorized '405': description: Invalid request '500': description: Server-side failure content: application/json: schema: allOf: - $ref: '../NIPC.yaml#/components/schemas/FailureResponse' - $ref: '#/components/schemas/ExtensionErrorCodes' /extensions/{id}/firmware/status: get: tags: - NIPC API extensions summary: Get the status of a firmware upgrade of a device description: |- Get the status of a firmware upgrade of a device. REturns success when ongoing or completed, with a reason. Returns failure when upgrade has failed. Id cannot be a group-id. operationId: upgradeFirmwareStatus parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: requestId in: query description: Request ID of the firmware upgrade operation required: true schema: type: string example: 12345678-1234-5678-1234-56789abcdef4 responses: '200': description: Success headers: content: application/json: schema: allOf: - $ref: '../NIPC.yaml#/components/schemas/Id' - $ref: './Extension-ReadConditional.yaml#/components/schemas/Extension-StatusResponse' '303': description: See Other headers: Location: schema: type: string description: URL to get the firmware response example: /12345678-1234-5678-1234-56789abcdef4/extension/firmware?requestId=12345678-1234-5678-1234-56789abcdef4 content: application/json: schema: allOf: - $ref: '../NIPC.yaml#/components/schemas/Id' - $ref: './Extension-ReadConditional.yaml#/components/schemas/Extension-StatusResponse' examples: successExample: summary: Completed value: id: 12345678-1234-5678-1234-56789abcdef4 status: COMPLETED components: schemas: # Extensions ## a Firmware Extension Extension-Firmware: type: object properties: firmware: type: string enum: - nordic - silabs ExtensionErrorCodes: type: object properties: nipcStatus: type: integer format: int32 enum: - 1600 # Firmware rollback - 1601 # Firmware update failed ]]>

NIPC API conditional read extension

file "Extension-ReadConditional.yaml" # yaml-language-server: $schema=https://json-schema.org/draft/2020-12/schema openapi: 3.0.3 info: title: Non IP Device Control (NIPC) API read conditional extension description: |- Non IP Device Control (NIPC) API read conditional extension termsOfService: http://swagger.io/terms/ contact: email: bbrinckm@cisco.com license: name: TBD url: TBD version: 0.5.4 externalDocs: description: NIPC IETF draft url: https://datatracker.ietf.org/doc/draft-ietf-asdf-nipc/ servers: - url: "{gw_host}/nipc/draft-07" variables: gw_host: default: localhost description: Gateway Host tags: - name: NIPC API extensions description: |- APIs that simplify application interaction by implementing one or more basic APIs into a single API call. paths: ### Extensions /extensions/{id}/properties/read/conditional: post: tags: - NIPC API extensions summary: Conditional read of a property description: Conditional read of a property operationId: conditionalRead parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: propertyName in: query description: The SDF property name that needs to be read conditionally. required: true allowReserved: true schema: type: string example: "#/sdfObject/thermostat/sdfProperty/temperature" requestBody: content: application/json: schema: $ref: '#/components/schemas/Extension-ConditionalRead' required: true responses: '202': description: Accepted headers: Location: schema: type: string description: URL to get the conditional read status example: /12345678-1234-5678-1234-56789abcdef4/extension/property/temperature/read/conditional/status?requestId=12345678-1234-5678-1234-56789abcdef4 Retry-After: schema: type: integer description: Time in seconds to wait before retrying 'default': description: Error response content: application/json: schema: $ref: '../NIPC.yaml#/components/schemas/FailureResponse' callbacks: callbackEvent: "{$request.body#/callback.url}": post: requestBody: content: application/json: schema: anyOf: - allOf: - $ref: '../NIPC.yaml#/components/schemas/Id' - $ref: '../NIPC.yaml#/components/schemas/PropertyValue' - $ref: '../NIPC.yaml#/components/schemas/FailureResponse' examples: successExample: summary: Success value: id: 12345678-1234-5678-1234-56789abcdef4 property: https://example.com/heartrate#/sdfObject/thermostat/sdfProperty/temperature value: dGVzdA== failedResponse: summary: Failed value: id: 12345678-1234-5678-1234-56789abcdef4 status: 400 nipcStatus: 1000 detail: "Invalid request" property: https://example.com/heartrate#/sdfObject/thermostat/sdfProperty/temperature value: dGVzdA== responses: '200': description: Success get: tags: - NIPC API extensions summary: Get Conditional read response of a property description: Conditional read response of a property operationId: getConditionalRead parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: propertyName in: query description: The SDF property name that needs to be read conditionally. required: true allowReserved: true schema: type: string example: "#/sdfObject/thermostat/sdfProperty/temperature" - name: requestId in: query description: Request ID of the conditional read operation required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 responses: '200': description: Success headers: content: application/json: schema: allOf: - $ref: '../NIPC.yaml#/components/schemas/Value' application/octet-stream: schema: type: string format: binary description: Binary data of the property value default: description: Error response content: application/problem+json: schema: allOf: - $ref: '../NIPC.yaml#/components/schemas/FailureResponse' /extensions/{id}/properties/read/conditional/status: get: tags: - NIPC API extensions summary: Get Conditional read status of a property description: Conditional read status of a property operationId: getConditionalReadStatus parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 - name: propertyName in: query description: The SDF property name that needs to be read conditionally. required: true allowReserved: true schema: type: string example: "#/sdfObject/thermostat/sdfProperty/temperature" - name: requestId in: query description: Request ID of the conditional read operation required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 responses: '200': description: OK headers: content: application/json: schema: allOf: - $ref: '#/components/schemas/Extension-StatusResponse' '303': description: See Other headers: Location: schema: type: string description: URL to get the conditional read response example: /12345678-1234-5678-1234-56789abcdef4/extension/property/temperature/read/conditional?requestId=12345678-1234-5678-1234-56789abcdef4 content: application/json: schema: allOf: - $ref: '#/components/schemas/Extension-StatusResponse' examples: successExample: summary: Completed value: id: 12345678-1234-5678-1234-56789abcdef4 status: COMPLETED components: schemas: # Extensions Extension-Callback: type: object properties: callback: type: object properties: url: description: |- URL to send the callback to (default is the same as the request URL) type: string example: "http://localhost:8080/callback" headers: description: |- Headers to include in the callback (default is empty) type: object example: x-api-key: "1234567890" additionalProperties: type: string Extension-StatusResponse: type: object properties: status: description: |- Status of the callback type: string enum: - IN_PROGRESS - COMPLETED Extension-ConditionalRead: allOf: - $ref: '../NIPC.yaml#/components/schemas/Value' - $ref: '#/components/schemas/Extension-Callback' - type: object properties: maxRepeat: description: |- maximum time the conditional read should repeat (default 5, max 10) type: integer example: 5 retryTime: description: |- time between reads in seconds (default 1, max 10) type: integer example: 1 ]]>

NIPC API property extensions

file "Extension-Property.yaml" # yaml-language-server: $schema=https://json-schema.org/draft/2020-12/schema openapi: 3.0.3 info: title: Non IP Device Control (NIPC) API read conditional extension description: |- Non IP Device Control (NIPC) API read conditional extension termsOfService: http://swagger.io/terms/ contact: email: bbrinckm@cisco.com license: name: TBD url: TBD version: 0.5.4 externalDocs: description: NIPC IETF draft url: https://datatracker.ietf.org/doc/draft-ietf-asdf-nipc/ servers: - url: "{gw_host}/nipc/draft-07" variables: gw_host: default: localhost description: Gateway Host tags: - name: NIPC API extensions description: |- APIs that simplify application interaction by implementing one or more basic APIs into a single API call. paths: ### Extensions /extensions/{id}/manage/transmit: post: tags: - NIPC API extensions summary: Broadcast to a device description: |- Broadcast a payload to a device. The broadcast is performed on the AP where the device was last seen operationId: ActionBroadcast parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 requestBody: content: application/json: schema: $ref: '#/components/schemas/Transmit' required: true responses: '200': description: Success default: description: Error response content: application/problem+json: schema: $ref: '../NIPC.yaml#/components/schemas/FailureResponse' /extensions/{id}/properties/write: post: tags: - NIPC API extensions summary: Write a value to an property using protocol mapping description: |- Write a value to an unregistered property, embedding property protocol mapping in the API, this does not require property registration. You cannot write to a group id. operationId: ActionPropWrite parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 requestBody: content: application/json: schema: allOf: - $ref: '../NIPC.yaml#/components/schemas/Value' - $ref: '../protocolmaps/ProtocolMap.yaml#/components/schemas/ProtocolMap-Property' required: true responses: '204': description: Success, no content default: description: Error response content: application/problem+json: schema: $ref: '../NIPC.yaml#/components/schemas/FailureResponse' /extensions/{id}/properties/read: post: tags: - NIPC API extensions summary: Read a value to an property using protocol mapping description: |- Read a value from an unregistered property, embedding property protocol mapping in the API, this does not require property registration. You cannot read from a group id. operationId: ActionPropRead parameters: - name: id in: path description: The ID of the device. Group ID is not allowed. required: true schema: type: string format: uuid example: 12345678-1234-5678-1234-56789abcdef4 requestBody: content: application/json: schema: $ref: '../protocolmaps/ProtocolMap.yaml#/components/schemas/ProtocolMap-Property' required: true responses: '200': description: Success content: application/json: schema: allOf: - $ref: '../NIPC.yaml#/components/schemas/Value' default: description: Error response content: application/problem+json: schema: $ref: '../NIPC.yaml#/components/schemas/FailureResponse' components: schemas: Transmit: allOf: - $ref: '../protocolmaps/ProtocolMap.yaml#/components/schemas/ProtocolMap-Broadcast' required: - cycle type: object properties: cycle: type: string example: single enum: - single - repeat # transmit time in ms transmitTime: type: integer example: 3000 # interval between transmits in ms transmitInterval: type: integer example: 500 payload: type: string format: byte example: AgEaAgoMFv9MABAHch9BsDkgeA== ]]>

Example SDF model with protocol mappings for BLE

file "thermometer.sdf.json" { "namespace": { "thermometer": "https://example.com/thermometer" }, "defaultNamespace": "thermometer", "sdfThing": { "thermometer": { "sdfObject": { "health_thermometer": { "description": "Health Thermometer", "sdfProperty": { "temperature_type": { "description": "Temperature Type", "observable": false, "writable": false, "readable": true, "protocolMap": { "ble": { "serviceID": "1809", "characteristicID": "2A1D" } } }, "measurement_interval": { "description": "Measurement Interval", "observable": false, "writable": false, "readable": true, "protocolMap": { "ble": { "serviceID": "1809", "characteristicID": "2A21" } } } }, "sdfEvent": { "temperature_measurement": { "description": "Temperature Measurement", "sdfOutputData": { "protocolMap": { "ble": { "type": "gatt", "serviceID": "1809", "characteristicID": "2A1C" } } } }, "intermediate_temperature": { "description": "Intermediate Temperature", "sdfOutputData": { "protocolMap": { "ble": { "type": "gatt", "serviceID": "1809", "characteristicID": "2A1E" } } } } } } }, "description": "Generic Access, Device Information", "sdfProperty": { "device_name": { "description": "Device Name", "observable": false, "writable": true, "readable": true, "protocolMap": { "ble": { "serviceID": "1800", "characteristicID": "2A00" } } }, "appearance": { "description": "Appearance", "observable": false, "writable": false, "readable": true, "protocolMap": { "ble": { "serviceID": "1800", "characteristicID": "2A01" } } }, "manufacturer_name_string": { "description": "Manufacturer Name String", "observable": false, "writable": false, "readable": true, "protocolMap": { "ble": { "serviceID": "180A", "characteristicID": "2A29" } } }, "model_number_string": { "description": "Model Number String", "observable": false, "writable": false, "readable": true, "protocolMap": { "ble": { "serviceID": "180A", "characteristicID": "2A24" } } }, "hardware_revision_string": { "description": "Hardware Revision String", "observable": false, "writable": false, "readable": true, "protocolMap": { "ble": { "serviceID": "180A", "characteristicID": "2A27" } } }, "firmware_revision_string": { "description": "Firmware Revision String", "observable": false, "writable": false, "readable": true, "protocolMap": { "ble": { "serviceID": "180A", "characteristicID": "2A26" } } }, "system_id": { "description": "System ID", "observable": false, "writable": false, "readable": true, "protocolMap": { "ble": { "serviceID": "180A", "characteristicID": "2A23" } } } }, "sdfEvent": { "isPresent": { "description": "BLE advertisements", "sdfOutputData": { "protocolMap": { "ble": { "type": "advertisements" } } } }, "isConnected": { "description": "BLE connection events", "sdfOutputData": { "protocolMap": { "ble": { "type": "connection_events" } } } } } } } } ]]>