79e6b0e0f6
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>. This patch proposes to then include <zephyr/kernel.h> instead of <zephyr/zephyr.h> since it is more clear that you are including the Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a catch-all header that may be confusing. Most applications need to include a bunch of other things to compile, e.g. driver headers or subsystem headers like BT, logging, etc. The idea of a catch-all header in Zephyr is probably not feasible anyway. Reason is that Zephyr is not a library, like it could be for example `libpython`. Zephyr provides many utilities nowadays: a kernel, drivers, subsystems, etc and things will likely grow. A catch-all header would be massive, difficult to keep up-to-date. It is also likely that an application will only build a small subset. Note that subsystem-level headers may use a catch-all approach to make things easier, though. NOTE: This patch is **NOT** removing the header, just removing its usage in-tree. I'd advocate for its deprecation (add a #warning on it), but I understand many people will have concerns. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> |
||
|---|---|---|
| .. | ||
| boards | ||
| src | ||
| CMakeLists.txt | ||
| README.rst | ||
| prj.conf | ||
| sample.yaml | ||
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.