zephyr/samples/net/gsm_modem
Torsten Rasmussen 407b49b35c cmake: use find_package to locate Zephyr
Using find_package to locate Zephyr.

Old behavior was to use $ENV{ZEPHYR_BASE} for inclusion of boiler plate
code.

Whenever an automatic run of CMake happend by the build system / IDE
then it was required that ZEPHYR_BASE was defined.
Using ZEPHYR_BASE only to locate the Zephyr package allows CMake to
cache the base variable and thus allowing subsequent invocation even
if ZEPHYR_BASE is not set in the environment.

It also removes the risk of strange build results if a user switchs
between different Zephyr based project folders and forgetting to reset
ZEPHYR_BASE before running ninja / make.

Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-03-27 16:23:46 +01:00
..
boards
src
CMakeLists.txt cmake: use find_package to locate Zephyr 2020-03-27 16:23:46 +01:00
README.rst samples: net: gsm_modem: Add README file 2020-02-18 18:52:43 +02:00
frdm_uart2_dts.overlay
prj.conf samples: net: modem: Add net and modem shells 2020-02-06 10:19:25 +02:00
sample.yaml sample: net: gsm_modem: Add sample.yaml file 2020-02-11 13:49:22 +02:00

README.rst

.. _gsm-modem-sample:

Generic GSM Modem Sample
########################

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.