Commit 305bd00f authored by David Boddie's avatar David Boddie

Move the mini-tutorials into the How To Guides

Tidy up formatting and add a bit more introductory text.
parent 5f6e35b5
......@@ -12,8 +12,8 @@ If you are developing applications that do not rely on specific features of the
phone, or that only need to be tested for use on a small screen, it can be
practical to :ref:`use an emulator <emulators>` to help with development.
Also take a look at the :ref:`mini-tutorials` page for some common
commands and some application setup that is not board specific.
Also take a look at the :ref:`devkit_howto` page for some common
commands and routine tasks.
.. toctree::
:maxdepth: 2
......@@ -23,7 +23,6 @@ commands and some application setup that is not board specific.
Boards/Troubleshooting
Boards/HowTo
Boards/dev-kit/modem
Boards/mini-tutorials
Boards/Legacy/index
.. _`EmCraft i.MX 8M SoM`: https://www.emcraft.com/products/868
......
......@@ -9,5 +9,8 @@ how to perform routine tasks.
.. toctree::
:maxdepth: 2
HowTo/Data_Connections
HowTo/Location_Services
HowTo/SSH_Access
HowTo/USB_Access
HowTo/Wireless_Networking
Data connections
================
Log in to the development board via the network (Ethernet, Wi-Fi) or the USB
serial console.
Use the following commands to test basic connectivity::
# Most basic check, works without SIM card:
mmcli -m 0
# Needs a SIM card inserted:
mmcli -i 0 --pin=<yourpin>
mmcli -m 0 --enable
mmcli -m 0 --simple-connect=apn=internet
mmcli -m 0 --simple-disconnect
If this works use ``nm-connection-editor`` on Wayland to create a Network
Manager connection named ``test``. You can then bring the connection up and
down using these commands::
nmcli con up test
nmcli con down test
Location Services
=================
The GNSS module has a dedicated serial port at ``/dev/ttymxc2``, operating at
9600 baud. You can use a terminal emulator to interact with this device::
root@pureos:~# picocom -b9600 /dev/ttymxc2
$GNRMC,,V,,,,,,,,,,N*4D
$GNVTG,,,,,,,,,N*2E
It is also supported by ``gpsd``.
There is an additional GPS module on the SIMCOM modem. This modem is not meant
to be used on the final phone. It has been shipped without an an antenna on the
development board, making it inoperable.
.. _mini-tutorials:
Mini-Tutorials
==============
This page is a collection of some helpful commands to setup various applications and test their functionality within the dev boards. These tidbits are not specific to any one board but are rather generally useful guides.
Data connections
----------------
Test basic connectivity::
# most basic check, works without sim card
mmcli -m 0
# Needs a sim card inserted
mmcli -i 0 --pin=<yourpin>
mmcli -m 0 --enable
mmcli -m 0 --simple-connect=apn=internet
mmcli -m 0 --simple-disconnect
If this works use *nm-connection-editor* on Wayland (will be part of the next image) to create a NetworkManager connection named *test*. You can then bring the connection up and down using::
nmcli con up test
nmcli con down test
Location services
-----------------
The GNSS module has a dedicated serial port at ``/dev/ttymxc2``, operating at 9600 baud.
root@pureos:~# picocom -b9600 /dev/ttymxc2
$GNRMC,,V,,,,,,,,,,N*4D
$GNVTG,,,,,,,,,N*2E
It's also supported by gpsd.
There is an additional GPS module on the SIMCOM modem. This modem is not meant to be used on the final phone. It has been shipped without an an antenna on the dev kit, making it inoperable.
Wireless Networking
###################
If you have your ethernet cable plugged in, you should automatically get a DHCP address on eth0. Alternatively, you can bring up the wireless interface with a DHCP address using Network Manager::
$ nmtui
1. Select "Edit a Connection". Hit enter.
2. Arrow over to "Add". Hit enter.
3. Arrow down to "Wi-Fi". Hit enter.
4. Wifi settings:
- Change the name if you'd like
- Arrow down to SSID and enter your wifi network name.
- Change the "Security" from "<none>" to the correct wifi security type ("WPA & WPA2 Personal" is most common) and enter your wifi network password on the field below.
- Arrow down to "OK" and hit enter.
5. Now you are on the screen with the list of your network connections where you should now see your wifi connection listed. Arrow to "Back" and hit enter.
6. Arrow down to "Activate a Connection". Hit enter.
7. Select your wifi connection and then arrow over to "Activate" and hit enter. You should see a pop-up that says "Connecting" and when that pop-up goes away, your connection should be active. Arrow down to "Back" and hit enter.
8. Arrow down to "Quit" and hit enter.
9. Now, back at the command prompt `ip addr` should show that your wlan0 interface has a DHCP address and your packets should be able to reach the outside world.
===================
If you have your Ethernet cable plugged in, you should automatically get a DHCP
address on ``eth0``. Alternatively, you can bring up the wireless interface
with a DHCP address using Network Manager by running the text user interface
from the command line::
purism@pureos:~$ nmtui
1. Select "Edit a Connection". Hit enter.
2. Arrow over to "Add". Hit enter.
3. Arrow down to "Wi-Fi". Hit enter.
4. Wifi settings:
* Change the name if you'd like
* Arrow down to SSID and enter your wifi network name.
* Change the "Security" from "<none>" to the correct wifi security type ("WPA
& WPA2 Personal" is most common) and enter your wifi network password on
the field below.
* Arrow down to "OK" and hit enter.
5. Now you are on the screen with the list of your network connections where
you should now see your wifi connection listed. Arrow to "Back" and hit
enter.
6. Arrow down to "Activate a Connection". Hit enter.
7. Select your wifi connection and then arrow over to "Activate" and hit enter.
You should see a pop-up that says "Connecting" and when that pop-up goes
away, your connection should be active. Arrow down to "Back" and hit enter.
8. Arrow down to "Quit" and hit enter.
9. Now, back at the command prompt, running ``ip addr`` should show that your
``wlan0`` interface has a DHCP address and your packets should be able to
reach the outside world.
::
purism@pureos:~$ ip addr
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
......@@ -92,4 +69,3 @@ If you have your ethernet cable plugged in, you should automatically get a DHCP
--- puri.sm ping statistics ---
3 packets transmitted, 3 received, 0% packet loss, time 2000ms
rtt min/avg/max/mdev = 154.192/160.226/165.224/4.586 ms
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment