CoAP


from network import WLAN
from network import Coap

# Connect to the network
wlan = WLAN(mode=WLAN.STA)
wlan.connect('your-ssid', auth=(WLAN.WPA2, 'your-key'))

# Initialize Coap module as CoAp Server, enable new resources to be added via PUT 
Coap.init(str(wlan.ifconfig()[0]), service_discovery=True, dynamic_resources=True)

# Add an example resource with URI "resource1" and value "default_value" and content format "plain text" 
r = Coap.add_resource("resource1", media_type=Coap.MEDIATYPE_TEXT_PLAIN, value="default_value")
# Configure the possible operations on the resource
r.callback(Coap.REQUEST_GET | Coap.REQUEST_POST | Coap.REQUEST_PUT, True)

Usage Example of CoAp Client


from network import WLAN
from network import Coap

# Callback handling the responses to the requests sent to a Coap Server
def response_callback(code, id_param, type_param, token, payload):
    print("Code: {}".format(code))
    # The ID can be used to pair the requests with the responses
    print("ID: {}".format(id_param))
    print("Type: {}".format(type_param))
    print("Token: {}".format(token))
    print("Payload: {}".format(payload))

# Connect to the network
wlan = WLAN(mode=WLAN.STA)
wlan.connect('your-ssid', auth=(WLAN.WPA2, 'your-key'))

# Initialize Coap module
Coap.init(str(wlan.ifconfig()[0]))

# Register the response handler for the requests the module initiates as a Coap Client
Coap.register_response_handler(response_callback)
# Create a new Client Session to use to communicate with the CoAp Server
session = Coap.new_client_session("server-ip-address")

# Send a GET Request to the CoAp Server asking for all resources via URI ".well-known/core"
id = session.send_request(Coap.REQUEST_GET, uri_path=".well-known/core")
print(id)

Initialization

Coap.init(address, *, port=5683, service_discovery=False, dynamic_resources=False, psk=None, hint=None)

When dynamic_resources is TRUE new resources can be created via PUT reqeusts, if the resource with the given URI does not already exist. The new resource is created with default properties (no mediatype, no Max-Age and no ETAG is enabled) and with default value received in the PUT request. On the new resource by default all operations (GET, PUT, POST and DELETE) are enabled.

Methods:

Coap.add_resource(uri, *, media_type=-1, max_age=-1, value=0, etag=False)

Coap.remove_resource(uri)

Coap.get_resource(uri)

Coap.register_response_handler(callback)

Registers a callback function which will be called when a remote CoAp Server responses to the local CoAp client’s request.

Coap.register_new_resource_handler(callback)

Registers a callback function which will be called when a new resource has been created via PUT operation.

Coap.new_client_session(address, *, port=5683, psk=None, identity=None)

Creates a new CoAp Client Session which can be used to communicate with an external CoAp Server.

Coap.remove_client_session(destination, port=5683, protocol=UDP)

Coap.get_client_sessions()

Class Client Session

The CoAp Client Session class represents a Client Session in the scope of the CoAp module which can be used to communicate with an external CoAp Server. A new CoAp Client Session can only be created with the Coap.new_client_session function.

CoapClientSession.send_request(method, *, uri_path, content_format, payload, token, include_options=true)

Creates and sends a request to the external CoAp Server defined by the destination and port parameters when this CoAp Client Session was created.

CoapClientSession.get_details()

Returns with a list of elements showing internal information about this CoAP Client Session:

Class CoapResource

The CoapResource class represents a resource in the scope of the CoAp module when acting as a server.

Class methods

CoapResource.add_attribute(name, value)

Adds a new attribute to the resource. Attributes are used to explain the resource during service discovery.

CoapResource.get_details()

CoapResource.set_details(*, mediatype, max_age, etag)

This function leaves untouched any property of the resource not given as a parameter.

CoapResource.value(value)

CoapResource.callback(operation, enable)

To enable or disable a specific operation (GET, PUT, POST, DELETE) on the resource.