Skip to content

ESP-NOW documentation and updating Coap documentation after esp-idf 4.1 update #292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
geza-pycom wants to merge 9 commits into from
Closed

ESP-NOW documentation and updating Coap documentation after esp-idf 4.1 update #292

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
afdaa96
Add documentation of ESP-NOW module
geza-pycom Dec 19, 2020
4f595ee
Updating Coap documentation after esp-idf 4 update
geza-pycom Jun 3, 2020
5716ff4
Update documentation for feature which enables new resource creation …
geza-pycom Jan 20, 2021
3c4c862
Updating based on the review comments
geza-pycom Jan 22, 2021
65f811e
Update ESP-NOW documentation as per review findings
geza-pycom Jan 26, 2021
0034ce2
Update Coap documentation as per review findings
geza-pycom Jan 27, 2021
3905d00
Small fix in Coap example
geza-pycom Jan 27, 2021
b84fdb0
Add extra info to espnow.init() that WLAN must be initialized before …
geza-pycom Jan 27, 2021
982a9c6
Adding documentation of Coap over DTLS
geza-pycom Feb 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions content/firmwareapi/pycom/network/coap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,16 +82,18 @@ print(id)

## Initialization

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

Initialize the CoAp module.

The arguments are:

* `address` is the address where the CoAp module handles communication when it is a Server. If not set, the module can be used as a CoAp Client only.
* `port` is the port where the CoAp Server listens. If not set, the default CoAp UDP port is 5683.
* `port` is the port where the CoAp Server listens. If not set, the default CoAp UDP port 5683 is used if no PSK is given otherwise the default CoAp DTLS port 5684 is used.
* `service_discovery` is a Boolean argument that enables/disables service discovery. If enabled, the CoAp Server will listen on the CoAp multicast address: 224.0.1.187. This is disabled by default.
* `dynamic_resources` is a Boolean argument that enables/disables new resource creation via PUT operations. This is disabled by default.
* `psk` is a String representing the Pre-Shared Key to be used for the DTLS connection.
* `hint` is a String representing the hint value to be used for the DTLS connection.

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.
Expand Down Expand Up @@ -158,13 +160,14 @@ Registers a callback function which will be called when a new resource has been
* `callback` is the callback to be registered. The callback must have 1 argument:
* `resource` is the new resource which has been created

#### Coap.new_client_session(destination, port=5683, protocol=UDP)
#### Coap.new_client_session(address, *, port=5683, psk=None, identity=None)
Copy link
Copy Markdown
Contributor

@peter-pycom peter-pycom Feb 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

new_client_session() has lost the protocol param, but remove_client_session() still has it. intentional?

Copy link
Copy Markdown
Contributor Author

@geza-pycom geza-pycom Feb 10, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it is.
When you call new_client_session() the Protocol is figured out based on the PSK and Identity parameters.
When you cal remove_client_session() it may happen that you have 2 Clients connected to the same Port, but one is using UDP the other is DTLS.


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

* `destination` is the IPv4 Address of the CoAp Server to join.
* `port` is the port of the CoAp Server to join. If not set, the default CoAp UDP port 5683 is used.
* `protocol` is the protocol to use to communicate with the CoAp Server. If not set the protocol UDP is used. Currently no other protocols than UDP is supported.
* `address` is the IPv4 Address of the CoAp Server to join.
* `port` is the port of the CoAp Server to join. If not set, the default CoAp UDP port 5683 is used if no PSK is given otherwise the default CoAp DTLS port 5684 is used.
* `psk` is a String representing the Pre-Shared Key to be used for the DTLS connection.
* `identity` is a String representing the identity value to be used for the DTLS connection.


#### Coap.remove_client_session(destination, port=5683, protocol=UDP)
Expand All @@ -173,7 +176,7 @@ Removes the specified CoAp Client Session.

* `destination` is the IPv4 Address of the CoAp Server where this CoAp Client Session has joined.
* `port` is the port of the CoAp Server where this CoAp Client Session has joined. If not set, the default CoAp UDP port 5683 is used.
* `protocol` is the protocol to use to communicate with the CoAp Server where this CoAp Client Session has joined. If not set the protocol UDP is used. Currently no other protocols than UDP is supported.
* `protocol` is the protocol to be used to communicate with the CoAp Server where this CoAp Client Session has joined. This value can be: `Coap.PROTOCOL_UDP`,`Coap.PROTOCOL_DTLS`, if not set the protocol UDP is used.

#### Coap.get_client_sessions()

Expand Down Expand Up @@ -275,3 +278,4 @@ Due to limitations of the underlying ESP-IDF/libcoap library, new resources cann

* Define the media type: `Coap.MEDIATYPE_TEXT_PLAIN`, `Coap.MEDIATYPE_APP_LINK_FORMAT`, `Coap.MEDIATYPE_APP_XML`, `Coap.MEDIATYPE_APP_OCTET_STREAM`, `Coap.MEDIATYPE_APP_RDF_XML`, `Coap.MEDIATYPE_APP_EXI`, `Coap.MEDIATYPE_APP_JSON`, `Coap.MEDIATYPE_APP_CBOR`
* Define the operation: `Coap.REQUEST_GET`, `Coap.REQUEST_PUT`, `Coap.REQUEST_POST`, `Coap.REQUEST_DELETE`
* Define the protocol: `Coap.PROTOCOL_UDP`,`Coap.PROTOCOL_DTLS`