Skip to content

Commit

Permalink
applications: serial_lte_modem: Fix #XHTTPCRSP's documentation
Browse files Browse the repository at this point in the history
The advertised syntax was incorrect and contradictory
to examples appearing on the same page.
It now reflects the actual syntax used by the SLM.

Signed-off-by: Tomi Fontanilles <tomi.fontanilles@nordicsemi.no>
  • Loading branch information
tomi-font committed Aug 23, 2023
1 parent 475b583 commit 4473e68
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions applications/serial_lte_modem/doc/HTTPC_AT_commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ Response syntax

::

#XHTTPCCON=<state>
#XHTTPCCON: <state>

* The ``<state>`` value can return one of the following:
* ``<state>`` is one of the following:

* ``0`` - Disconnected
* ``1`` - Connected
Expand Down Expand Up @@ -78,7 +78,7 @@ Response syntax

::

XHTTPCCON: <state>,<host>,<port>[,<sec_tag>]]
XHTTPCCON: <state>,<host>,<port>[,<sec_tag>]

Example
~~~~~~~
Expand Down Expand Up @@ -151,9 +151,9 @@ Response syntax

::

#XHTTPCREQ:<state>
#XHTTPCREQ: <state>

The ``<state>`` value can return one of the following:
``<state>`` is one of the following:

* ``0`` - Request sent successfully
* ``1`` - Wait for payload data
Expand Down Expand Up @@ -245,13 +245,12 @@ Syntax

::

#XHTTPCRSP=<byte_received>,<state><CR><LF><response>
<response><CR><LF>#XHTTPCRSP:<received_byte_count>,<state>

* The ``<byte_received>`` is an integer.
* ``<response>`` is the raw data of the HTTP response, including headers and body.
* ``<received_byte_count>`` is an integer.
It represents the length of a partially received HTTP response.
* The ``<state>`` value can return one of the following:
* ``<state>`` is one of the following:

* ``0`` - There is more HTTP response data to come.
* ``1`` - The entire HTTP response has been received.

* The ``<response>`` is the raw data of the HTTP response, including headers and body.

0 comments on commit 4473e68

Please sign in to comment.