example_api_list.md

January 10, 2017 · View on GitHub

client-defineset-example

This example demonstrates how to define a new object definition, consisting of a number of resources, on the client using a DEFINE operation.

client-definition-iterator-example

This example demonstrates how the AwaObjectDefinitionIterator and AwaResourceDefinitionIterator can be used to iterate through all of the objects and resources that have been previously defined in a client session.

client-delete-array-range-example

This example demonstrates how to delete a range of resource instances from a multi-instance resource (array) on the client using a DELETE operation.

client-delete-example

This example demonstrates how to delete a resource from the client using a DELETE operation.

client-get-array-example

This example demonstrates how to retrieve the value of a resource instance from a multi-instance resource (array) on the client using a GET operation.

client-get-contains-path-example

This example demonstrates how to test whether a GET operation response contains a specific path. It also demonstrates retrieval of a value from a string resource.

client-get-example

This example demonstrates how to retrieve the value of a resource from the client using a GET operation.

client-set-array-example

This example demonstrates how to set the value of a resource instance of a multi-instance resource on the client using the SET operation.

client-set-create-example

This example demonstrates how to create and set the value of an optional resource on the client using the SET operation.

client-set-example

This example demonstrates how to set the value of a resource on the client using the SET operation.

This example demonstrates how to subscribe to the client for notifications of changes to the value of a resource, using a SUBSCRIBE to CHANGE operation.

This example is a little contrived in that it creates a subscription and then triggers the notification itself. In most cases, the notification will be triggered by a WRITE operation initiated by the server.

This example demonstrates how to subscribe to the client for notifications of execution of a resource, using a SUBSCRIBE to EXECUTE operation.

This example is a little contrived in that it creates a subscription and then triggers the notification itself. In most cases, the notification will be triggered by an EXECUTE operation initiated by the server.

server-defineset-example

This example demonstrates how to define a new object definition, consisting of a number of resources, on the server using a DEFINE operation.

server-delete-object-instance-example

This example demonstrates how to delete an object instance from the server using the DELETE operation.

server-event-example

This example demonstrates how to respond to client events from the server.

If a client registers, deregisters or updates its registration with the server, an application callback is invoked.

To run this example, run an Awa server and then run this example. Then start a LWM2M client (such as the Awa client) and have it register with this server. Hit CTRL-C to terminate.

server-execute-arguments-example

This example demonstrates how to initiate an EXECUTE operation via the server, passing application-specific data to the executable resource on the client.

server-execute-example

This example demonstrates how to initiate an EXECUTE operation via the server, targeting an executable resource on the client.

server-list-clients-example

This example demonstrates how to obtain a list of all registered clients from the server using a LIST_CLIENTS operation. In addition, the list of registered objects and object instances is extracted from the response.

server-observe-example

This example demonstrates how to observe a client's resource via the server. If the resource changes and a notification is generated, an application callback is invoked.

This example is a little contrived in that it creates an observation and then triggers the notification itself with a WRITE. In many cases, the notification will be triggered by an update to the resource value by another entity such as the client itself.