diff --git a/esp_modem/.doctrees/advanced_api.doctree b/esp_modem/.doctrees/advanced_api.doctree index 5ce332cb7..d49603af8 100644 Binary files a/esp_modem/.doctrees/advanced_api.doctree and b/esp_modem/.doctrees/advanced_api.doctree differ diff --git a/esp_modem/.doctrees/api_docs.doctree b/esp_modem/.doctrees/api_docs.doctree index 3b0beea01..29ff744fc 100644 Binary files a/esp_modem/.doctrees/api_docs.doctree and b/esp_modem/.doctrees/api_docs.doctree differ diff --git a/esp_modem/.doctrees/cxx_api_docs.doctree b/esp_modem/.doctrees/cxx_api_docs.doctree index 1a6748e64..50b014b90 100644 Binary files a/esp_modem/.doctrees/cxx_api_docs.doctree and b/esp_modem/.doctrees/cxx_api_docs.doctree differ diff --git a/esp_modem/.doctrees/cxx_api_links.doctree b/esp_modem/.doctrees/cxx_api_links.doctree index 1eeb98fb4..d49cc6dc6 100644 Binary files a/esp_modem/.doctrees/cxx_api_links.doctree and b/esp_modem/.doctrees/cxx_api_links.doctree differ diff --git a/esp_modem/.doctrees/environment.pickle b/esp_modem/.doctrees/environment.pickle index 112b25e59..8b9e45fb5 100644 Binary files a/esp_modem/.doctrees/environment.pickle and b/esp_modem/.doctrees/environment.pickle differ diff --git a/esp_modem/.doctrees/internal_docs.doctree b/esp_modem/.doctrees/internal_docs.doctree index 030b82340..f5dd92f55 100644 Binary files a/esp_modem/.doctrees/internal_docs.doctree and b/esp_modem/.doctrees/internal_docs.doctree differ diff --git a/esp_modem/_sources/cxx_api_links.rst.txt b/esp_modem/_sources/cxx_api_links.rst.txt index 73d33092c..6fc9efff5 100644 --- a/esp_modem/_sources/cxx_api_links.rst.txt +++ b/esp_modem/_sources/cxx_api_links.rst.txt @@ -22,4 +22,14 @@ - :cpp:func:`esp_modem::DCE::get_battery_status` - :cpp:func:`esp_modem::DCE::power_down` - :cpp:func:`esp_modem::DCE::reset` -- :cpp:func:`esp_modem::DCE::set_baud` +- :cpp:func:`esp_modem::DCE::set_baud` +- :cpp:func:`esp_modem::DCE::set_operator` +- :cpp:func:`esp_modem::DCE::set_network_attachment_state` +- :cpp:func:`esp_modem::DCE::get_network_attachment_state` +- :cpp:func:`esp_modem::DCE::set_radio_state` +- :cpp:func:`esp_modem::DCE::get_radio_state` +- :cpp:func:`esp_modem::DCE::set_network_mode` +- :cpp:func:`esp_modem::DCE::set_preferred_mode` +- :cpp:func:`esp_modem::DCE::set_network_bands` +- :cpp:func:`esp_modem::DCE::get_network_system_mode` +- :cpp:func:`esp_modem::DCE::set_gnss_power_mode` diff --git a/esp_modem/advanced_api.html b/esp_modem/advanced_api.html index 05d56d833..211758609 100644 --- a/esp_modem/advanced_api.html +++ b/esp_modem/advanced_api.html @@ -68,6 +68,18 @@

Derived from the GenericModule, specifics applied to SIM7600 model

+
+
+enumerator SIM7070
+

Derived from the GenericModule, specifics applied to SIM7070 model

+
+ +
+
+enumerator SIM7000
+

Derived from the GenericModule, specifics applied to SIM7000 model

+
+
enumerator BG96
diff --git a/esp_modem/api_docs.html b/esp_modem/api_docs.html index 2747a03c8..7280d30cc 100644 --- a/esp_modem/api_docs.html +++ b/esp_modem/api_docs.html @@ -114,6 +114,16 @@ enumerator ESP_MODEM_DCE_SIM7600
+
+
+enumerator ESP_MODEM_DCE_SIM7070
+
+ +
+
+enumerator ESP_MODEM_DCE_SIM7000
+
+
enumerator ESP_MODEM_DCE_BG96
@@ -525,6 +535,150 @@ pointer as the return value. The API expects the output data to point to user al
+
+
+command_result esp_modem_set_operator(int mode, int format, const char *oper)
+

Force an attempt to connect to a specific operator.

+
+
Parameters:
+
    +

  • mode – [in] mode of attempt mode=0 - automatic mode=1 - manual mode=2 - deregister mode=3 - set format for read operation mode=4 - manual with fallback to automatic

    • +

  • format – [in] what format the operator is given in format=0 - long format format=1 - short format format=2 - numeric

    • +

  • oper – [in] the operator to connect to

    • +
+
+
Returns:
+

OK, FAIL or TIMEOUT

+
+
+
+ +
+
+command_result esp_modem_set_network_attachment_state(int state)
+

Attach or detach from the GPRS service.

+
+
Parameters:
+

state – [in] 1-attach 0-detach

+
+
Returns:
+

OK, FAIL or TIMEOUT

+
+
+
+ +
+
+command_result esp_modem_get_network_attachment_state(int *state)
+

Get network attachment state.

+
+
Parameters:
+

state – [out] 1-attached 0-detached

+
+
Returns:
+

OK, FAIL or TIMEOUT

+
+
+
+ +
+
+command_result esp_modem_set_radio_state(int state)
+

What mode the radio should be set to.

+
+
Parameters:
+

state – [in] state 1-full 0-minimum …

+
+
Returns:
+

OK, FAIL or TIMEOUT

+
+
+
+ +
+
+command_result esp_modem_get_radio_state(int *state)
+

Get current radio state.

+
+
Parameters:
+

state – [out] 1-full 0-minimum …

+
+
Returns:
+

OK, FAIL or TIMEOUT

+
+
+
+ +
+
+command_result esp_modem_set_network_mode(int mode)
+

Set network mode.

+
+
Parameters:
+

mode – [in] preferred mode

+
+
Returns:
+

OK, FAIL or TIMEOUT

+
+
+
+ +
+
+command_result esp_modem_set_preferred_mode(int mode)
+

Preferred network mode (CAT-M and/or NB-IoT)

+
+
Parameters:
+

mode – [in] preferred selection

+
+
Returns:
+

OK, FAIL or TIMEOUT

+
+
+
+ +
+
+command_result esp_modem_set_network_bands(const char *mode, const int *bands, int size)
+

Set network bands for CAT-M or NB-IoT.

+
+
Parameters:
+

mode – [in] CAT-M or NB-IoT

+
+
Returns:
+

OK, FAIL or TIMEOUT

+
+
+
+ +
+
+command_result esp_modem_get_network_system_mode(int *mode)
+

Show network system mode.

+
+
Parameters:
+

mode – [out] current network mode

+
+
Returns:
+

OK, FAIL or TIMEOUT

+
+
+
+ +
+
+command_result esp_modem_set_gnss_power_mode(int mode)
+

GNSS power control.

+
+
Parameters:
+

mode – [out] power mode (0 - off, 1 - on)

+
+
Returns:
+

OK, FAIL or TIMEOUT

+
+
+
+
diff --git a/esp_modem/cxx_api_docs.html b/esp_modem/cxx_api_docs.html index c4bc4d2ad..e9a3e79df 100644 --- a/esp_modem/cxx_api_docs.html +++ b/esp_modem/cxx_api_docs.html @@ -120,6 +120,18 @@ +
+
+std::unique_ptr<DCE> create_SIM7070_dce(const dce_config *config, std::shared_ptr<DTE> dte, esp_netif_t *netif)
+

Create DCE based on SIM7070 module.

+
+ +
+
+std::unique_ptr<DCE> create_SIM7000_dce(const dce_config *config, std::shared_ptr<DTE> dte, esp_netif_t *netif)
+

Create DCE based on SIM7000 module.

+
+
std::unique_ptr<DCE> create_SIM800_dce(const dce_config *config, std::shared_ptr<DTE> dte, esp_netif_t *netif)
@@ -187,6 +199,16 @@

  • esp_modem::DCE::power_down()

  • esp_modem::DCE::reset()

  • esp_modem::DCE::set_baud()

    • +

  • esp_modem::DCE::set_operator()()

    • +

  • esp_modem::DCE::set_network_attachment_state()

    • +

  • esp_modem::DCE::get_network_attachment_state()

    • +

  • esp_modem::DCE::set_radio_state()

    • +

  • esp_modem::DCE::get_radio_state()

    • +

  • esp_modem::DCE::set_network_mode()

    • +

  • esp_modem::DCE::set_preferred_mode()

    • +

  • esp_modem::DCE::set_network_bands()

    • +

  • esp_modem::DCE::get_network_system_mode()

    • +

  • esp_modem::DCE::set_gnss_power_mode()

    • diff --git a/esp_modem/cxx_api_links.html b/esp_modem/cxx_api_links.html index 755ace3bf..021aba646 100644 --- a/esp_modem/cxx_api_links.html +++ b/esp_modem/cxx_api_links.html @@ -56,6 +56,16 @@

  • esp_modem::DCE::power_down()

  • esp_modem::DCE::reset()

  • esp_modem::DCE::set_baud()

    • +

  • esp_modem::DCE::set_operator()()

    • +

  • esp_modem::DCE::set_network_attachment_state()

    • +

  • esp_modem::DCE::get_network_attachment_state()

    • +

  • esp_modem::DCE::set_radio_state()

    • +

  • esp_modem::DCE::get_radio_state()

    • +

  • esp_modem::DCE::set_network_mode()

    • +

  • esp_modem::DCE::set_preferred_mode()

    • +

  • esp_modem::DCE::set_network_bands()

    • +

  • esp_modem::DCE::get_network_system_mode()

    • +

  • esp_modem::DCE::set_gnss_power_mode()

    • diff --git a/esp_modem/genindex.html b/esp_modem/genindex.html index a519d1887..9d7310382 100644 --- a/esp_modem/genindex.html +++ b/esp_modem/genindex.html @@ -63,15 +63,19 @@
  • command_result::FAIL (C++ enumerator)
    • - - + - +

    Application Example

    -

    A simple WebSocket example that uses esp_websocket_client to establish a websocket connection and send/receive data with the websocket.org server can be found here: example .

    +

    A simple WebSocket example that uses esp_websocket_client to establish a websocket connection and send/receive data with the websocket.org server can be found here: example .

    Sending Text Data

    The WebSocket client supports sending data as a text data frame, which informs the application layer that the payload data is text data encoded as UTF-8. Example:

    @@ -328,7 +328,7 @@ In case a host operating system has openssl and sed pa

    Header File

    diff --git a/esp_websocket_client/search.html b/esp_websocket_client/search.html index 53fd667da..5cd906467 100644 --- a/esp_websocket_client/search.html +++ b/esp_websocket_client/search.html @@ -165,7 +165,7 @@ - Edit on GitHub + Edit on GitHub