zephyr

History

Benjamin Cabé 994558ef8e samples: net: doc: Use new Sphinx extension to document networking samples Use the new code-sample directive and roles to document the networking samples so that they show up as "Related samples" when browsing the various relevant networking APIs. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>		2023-09-19 15:22:59 +01:00
..
boards	samples/net: Add cellular modem sample	2023-08-30 13:48:51 +02:00
src	net: conn_mgr: Rename connectivity monitor	2023-08-29 16:13:37 +02:00
CMakeLists.txt	…
README.rst	samples: net: doc: Use new Sphinx extension to document networking samples	2023-09-19 15:22:59 +01:00
prj.conf	…
sample.yaml	…

README.rst

.. zephyr:code-sample:: gsm-modem
   :name: Generic GSM modem

   Use a GSM modem to connect to a GPRS network.

Overview
********

The Zephyr GSM modem sample application allows user to have a connection
to GPRS network. The connection to GSM modem is done using
:ref:`PPP (Point-to-Point Protocol) <ppp>`.

The source code of this sample application can be found at:
:zephyr_file:`samples/net/gsm_modem`.

Requirements
************

- GSM modem card. The sample has been tested with SIMCOM SIM808 card. All
  GSM modem cards should work as long as they support **AT+CGDCONT** command.
- Almost any Zephyr enabled board with sufficient resources can be used.
  The sample has been tested with :ref:`reel_board`.

Build and Running
*****************

If you are using an external modem like the SIMCOM card, then connect
the necessary pins like RX and TX from your Zephyr target board to the
modem card. Internal modems, like what is found in :ref:`particle_boron`
board, are not yet supported.

.. zephyr-app-commands::
   :zephyr-app: samples/net/gsm_modem
   :board: reel_board
   :goals: build flash
   :gen-args: -DCONFIG_MODEM_GSM_APN=\"internet\"
   :compact:

Note that you might need to change the APN name according to your GSM network
configuration.