documentation: Update README #1

Merged
dchvs merged 1 commits from 4.4.1/tx2-cti/quectel-module-dev into master 2021-02-19 22:14:28 -04:00
1 changed files with 53 additions and 48 deletions

101
README.md
View File

@ -1,5 +1,58 @@
# Quectel EG25-G GSM Modem # Quectel EG25-G GSM Modem
## Quectel Setup
The Quectel should be conencted to a ConnectTech's Elroy board.
The Quectel module requires to connect the antenna on the MAIN and GNSS sockets.
Make sure to use a SIM card with full access to the mobile network.
## Installation
Clone the repository:
```
mkdir ~/git/ && cd ~/git/
git clone https://git.spirirobotics.com/dchvs/eg25-g.git
cd eg25-g/
```
Create udhcpc directories, copy in the script, and give it execution permission:
```
sudo mkdir -p /usr/share/udhcpc
sudo mkdir -p /etc/udhcpc/
sudo cp quectel-CM/default.script /usr/share/udhcpc/
sudo cp quectel-CM/default.script /etc/udhcpc/
sudo chmod +x /usr/share/default.script
sudo chmod +x /etc/udhcpc/default.script
```
Create a udhcpc symbolic link:
```
sudo ln -s /bin/busybox /bin/udhcpc
```
Build the application:
```
cd quectel-CM/quectel-CM
make
```
## Running
The following command launches the package, with [apn-name] being substituted with the APN of the wireless provider. For BICS, the APN is bicsapn. To run this in the background, add & to the end of the command.
```
sudo ~/git/eg25-g/quectel-CM/quectel-CM -s [apn-name] &
```
## Troubleshooting
If the modem is correctly connected to the system, the following command will show the GSM modem attaching to ttyUSB0, ttyUSB1, ttyUSB2, and ttyUSB3:
```
dmesg | grep GSM
```
If the modem has successfully connected to a tower and is being served an IP address, then the following command will show an IP address being served:
```
ifconfig eth1
ping -I eth1 www.google.com
```
## Kernel Changes ## Kernel Changes
This package requires the Spiri Mu kernel and modifications to the following files: This package requires the Spiri Mu kernel and modifications to the following files:
* drivers/usb/serial/option.c * drivers/usb/serial/option.c
@ -15,54 +68,6 @@ It also requires these new files:
* drivers/net/usb/QMIDevice.h * drivers/net/usb/QMIDevice.h
* drivers/net/usb/Structs.h * drivers/net/usb/Structs.h
All these modifications and additions are part of the Spiri Mu kernel. The files are represented in https://git.spirirobotics.com/Spiri/mu_kernel_sources as symlinks from this repository.
## Installation
Clone the repository:
```
cd ~/git
git clone https://git.spirirobotics.com/Spiri/mu_packages.git
```
Create a udhcpc symbolic link:
```
cd /bin
sudo ln -s busybox udhcpc
```
Create udhcpc directories, copy in the script, and give it execution permission:
```
sudo mkdir -p /usr/share/udhcpc
sudo mkdir -p /etc/udhcpc/
sudo cp ~/git/mu_packages/eg25-g/default.script /usr/share/udhcpc
sudo cp ~/git/mu_packages/eg25-g/default.script /etc/udhcpc
sudo chmod +x /usr/share/default.script
sudo chmod +x /etc/udhcpc/default.script
```
Build the application:
```
cd ~/git/mu_packages/eg25-g/quectel-CM
make
```
## Running
The following command launches the package, with [apn-name] being substituted with the APN of the wireless provider. For BICS, the APN is bicsapn. To run this in the background, add & to the end of the command.
```
sudo ./git/mu_packages/eg25-g/quectel-CM/quectel -s [apn-name]
```
## Troubleshooting
If the modem is correctly connected to the system, the following command will show the GSM modem attaching to ttyUSB0, ttyUSB1, ttyUSB2, and ttyUSB3:
```
dmesg | grep GSM
```
If the modem has successfully connected to a tower and is being served an IP address, then the following command will show an IP address being served:
```
ifconfig eth1
```
## Documentation ## Documentation
* <a href="https://nextcloud.spirirobotics.com/f/3971">Cellular modem hardware design</a> * <a href="https://nextcloud.spirirobotics.com/f/3971">Cellular modem hardware design</a>
* <a href="https://nextcloud.spirirobotics.com/f/3970">Cellular modem PPP</a> * <a href="https://nextcloud.spirirobotics.com/f/3970">Cellular modem PPP</a>