michaelh/zephyr
1
0
Fork 0
Code Releases Activity

samples: net: gsm_modem: Add README file

Browse source 
Add documentation to the GSM modem sample application.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
This commit is contained in:
Jukka Rissanen 2020-02-13 11:21:30 +02:00 • committed by Johan Hedberg
commit 48a1a2ef81
1 changed files with 40 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

40
samples/net/gsm_modem/README.rst Normal file
View file

@ -0,0 +1,40 @@
.. _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.