Skip to content

Commit

Permalink
docs/psoc6/quickref.rst: Network module specialization docs.
Browse files Browse the repository at this point in the history
Signed-off-by: enriquezgarc <[email protected]>
  • Loading branch information
jaenrig-ifx authored and actions-user committed Jul 25, 2023
1 parent a3b5cf5 commit aa42209
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/psoc6/quickref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -244,40 +244,39 @@ The :mod:`network` module

See :ref:`network.WLAN <network.WLAN>`

For some methods and constants, the PSoC6 network port implement certain specialization and slightly different behavior. This is explained in this section.
For some methods and constants, the PSoC6 network port implements certain specialization and slightly different behavior. This is explained in this section.

Methods
^^^^^^^

.. method:: WLAN.scan(ssid=None, bssid=None)

The scan option accepts the following filters as keyword arguments, removing from scan results any network not matching these parameters values:

* ``ssid``
* ``bssid``

.. method:: WLAN.status('param')

..warning::
.. warning::
The function does not provide status of the connection. Use the ``active()`` for that purpose. Any errors or failure are communicated when using the corresponding enable/disable or connect/disconnect functions.

The following query parameters are allowed:
* ``rssi``. Only for STA.
* ``stations``. List of connected stations (only for AP).

.. method:: WLAN.config('param')
WLAN.config(param=value, ...)

.. method:: WLAN.config('param')
WLAN.config(param=value, ...)

Among the suggested parameters of the general network WLAN API, for this port, only these are available:
* AP & STA query parameters:

* AP & STA query parameters
- ``channel``
- ``ssid``
- ``security```
- ``key/password``. Only for default AP key.
- ``mac``
* AP set:
* AP set parameters
- ``channel``
- ``ssid``
- ``security```
Expand All @@ -288,6 +287,7 @@ Constants
^^^^^^^^^

Security modes constants:

.. data:: WLAN.OPEN
WLAN.WEP
WLAN.WPA
Expand Down

0 comments on commit aa42209

Please sign in to comment.