Template:Compute Module 4 PoE 4G Board manual

Precautions

Do not plug or unplug any devices while it is powered on.
All of the following are tested on Raspberry Pi OS, no other systems are supported.

Writing Image

• Write Image for Compute Module Boards eMMC version
• Wrote Image for Compute Module Boards Lite version

USB2.0

The USB interfaces are default disabled in CM4, you need to enable it by adding the following lines:the config.txt

dtoverlay=dwc2,dr_mode=host

It will take effect after restart

If you use the latest Raspberry Pi OS (image after October 30, 2021) USB2.0 is OTG mode by default, CM4 will report an error:

 config failed, hub doesn't have any ports! (err -19)

However, USB can still be used. If you want to remove this error, remove otg_mode=1 in [cm4] of config.txt, and add dtoverlay=dwc2, dr_mode=host (USB cannot be recognized without adding it).

Preparation before use

Demo Download

Open the Raspberry Pi terminal and execute the following commands:

sudo wget https://files.waveshare.com/upload/b/ba/Compute_Module_4_PoE_4G_Board_Code.zip
unzip -o  Compute_Module_4_PoE_4G_Board_Code.zip -d ./Compute_Module_4_PoE_4G_Board_Code
sudo chmod 777 -R Compute_Module_4_PoE_4G_Board_Code
cd Compute_Module_4_PoE_4G_Board_Code

Installing Libraries

All libraries are installed according to your needs, just install the one you need to use, you don't have to install all of them.
If you just test the function, you can directly use the C program without installing any library. Our C program does not need to install any library by default.
With the update of each version, there may be some software incompatibilities, or running an error, if this problem occurs, you can feedback to us

• Install BCM2835, open the Raspberry Pi terminal, and run the following command (not recommended)

#If you have any questions, please visit http://www.airspayce.com/mikem/bcm2835/
#Any other problems can be reported in the link above, please do not contact the author directly
wget http://www.airspayce.com/mikem/bcm2835/bcm2835-1.68.tar.gz
tar zxvf bcm2835-1.68.tar.gz
cd bcm2835-1.68/
sudo ./configure
sudo make
sudo make check
sudo make install

• install wiringpi

#WiringPi does not officially support CM4, but you can install the unofficial version because this version is not the official version
#This version is only for CM4
#Any other problems can be reported on GitHub, please do not contact the author directly
git clone https://github.com/WiringPi/WiringPi.git
cd WiringPi/
./build
#Execute gpio -v and the version number is 2.6.

• Install the Python function library

#python2
sudo apt-get update
sudo apt-get install python-pip
sudo apt-get install python-pil
sudo apt-get install python-numpy
sudo pip install RPi.GPIO
sudo pip install spidev
sudo pip2 install python-can
#python3
sudo apt-get update
sudo apt-get install python3-pip
sudo apt-get install python3-pil
sudo apt-get install python3-numpy
sudo pip3 install RPi.GPIO
sudo pip3 install spidev
sudo pip3 install python-can

Open I2C interface

• Execute in terminal:

sudo raspi-config
#Select Interfacing Options -> I2C ->yes to start the i2C kernel driver

 

• then restart the raspberry pi

sudo reboot

USB TO UART

The UART is connected to CM4 by default, and is connected to the GPIO14 (BCM) and GPIO15 (BCM) pins of CM4
When starting serial debugging, you can directly connect to the computer through this interface to log in to the CM4

You can also supply power through this interface, but the default is not able to supply power. If you need to supply power through this interface, please connect the resistor (0R) on the interface.

Buzzer/LED

Buzzer

The buzzer is connected to GPIO22(BCM 22), low active.

LED

Two LEDs are integrated for users, the green one is connected to GPIO20(BCM)and the red one is connected to GPIO21(BCM), low active.

【expected results】

Two user LEDs flash alternately.
LED changes once, the buzzer sounds once.

【Python examples】

cd LED_BUZZER/python/
sudo python main.py

【C examples】

cd LED_BUZZER/c/
make clean
sudo make
sudo ./main

4G/5G

To work with 4G/5G, you need to connect a wireless module to the M.2 B KEY for featuring corresponding functions. M.2 B KEY only extends USB2.0 interfaces, it doesn't support PCIE devices.

SIM card is required to work with the 4G/5G module
This carrier board supports the 4G module by default, if you use it with 5G modules, some of the 5G functions are not supported.
If you use a 5G module, please check the SIM8200EA-M2_5G HAT wiki about how to set up 5G.
It takes a certain amount of time (about 30 seconds) to close or open the mold
In the downloaded routine there is an M_2_PWR script that can be executed

sudo ./M_2_PWR 0
#Open the mod
sudo ./M_2_PWR 1
#Close the mod

Open the mod
The 5G module is not controlled by the enable pin

SIM7600 M.2 module

Status of M.2 indicators:

STA	NET	Status
On	Off	Off or starting
Long light	Long light	Looking for network
Steady on	Blinking	Connected and working fine
Off	Blinking/Solid	Shutting down

Before you configure the SIM7600 module, please make sure that the module is started normally.

sudo apt-get install minicom
sudo minicom -D /dev/ttyUSB2
# Enter the following commands:
AT+CUSBPIDSWITCH=9011,1,1
#return OK
#Then wait for the network card to restart
#This command only needs to be set once, the next time it is powered on, it will be in this mode by default
#If the USB0 network card cannot be obtained, execute:
sudo dhclient -v usb0

About RNIDS networking, please refer to Raspberry Pi networked via RNDIS RNIDS Networking method
With the operations above, a USB0 port will be recognized.(if you don't have other USB network card connected)
If you use an IoT card, such as a mobile IoT card, to successfully register the network; but the dial-up Internet connection fails and cannot be pinged, you can try to use one of the following AT commands to select the optimal frequency band:

 AT+CNBP=0x0002000000400183,0x000001E000000000,0x0000000000000021
 AT+CNBP=0x0002000000400180,0x480000000000000000000000000000000000000000000042000001E200000095,0x0000000000000021

AT Commands

If the network cannot work, plaese check module with AT commands

sudo apt-get install minicom
sudo minicom -D /dev/ttyUSB2

Common AT commands

Command	Description	Return
AT	AT test	OK
ATE	ATE1 enable echo ATE0 disable echo	OK
AT+CGMI	Check manfacture	OK
AT+CGMM	Check module type	OK
AT+CGSN	Check SN	OK
AT+CSUB	Check module version	OK
AT+CGMR	Check firmware version	OK
AT+IPREX	Configure hardwara baud rate	+IPREX: OK
AT+CRESET	Reset module	OK
AT+CSQ	Check signal quanlity	+CSQ: 17,99 OK
AT+CPIN?	Check SIM status	+CPIN: READY
AT+COPS?	CHeck the current supplier	+COPS: OK
AT+CREG?	Check network status	+CREG: OK
AT+CPSI?	Check UE information
AT+CNMP	Configure network mode： 2：Automatic 13：GSM only 38：LTE only 48 ： Any modes but LTE ... ....	OK

For more AT commands, please refer to： AT_Command_V2.00
You can also refer to：SIMCom

PCIE

The PCIe interface is PCIe 2.0 X1, the maximum speed is 500Mb/s
Support most PCIE x1 cards, many PCIEx1 device cards on the market, the default Raspberry Pi system is not supported, because the Raspberry Pi Linux does not add drivers.
Please check your PCIe device before you used Supported device testing
Raspberry Kernel compiling

Isolation GPIO/I2C

Isolation output pins are GPIO17 （BCM） and GPIO27（BCM）
Isolation input pins GPIO23 （BCM） and GPIO24（BCM）

Configure the logic voltage of Isolation IO

Isolation I2C pins are GPIO2/3（BCM），I2C bus is I2C1，

【Expected result】

The two OUT pins troggle in order
Read the values of two IN pins

【python example】

cd IO/python
sudo python main.py

【C example】

cd IO/c
make clean
sudo make
sudo ./main

Isolation ADC

The isolation ADC is mounted in isolation I2C with 0x48 address
I2C is default disabled, please refer to #Enable I2C to enable the I2C interface.

C

 cd ADC/c/
 sudo ./main 

python

 cd ADC/python/
 sudo python examples/main.py

• Run the commands above to run the example

Expected result

Output voltage vlaue

Note: the ADC chip used is ADS1113, its reference voltage is 2.048V, the range of differential input, Input voltage range: ±2.048V

CAN

The CAN is diabled by default, you need to modify the config.txt file for enabling it.

 #Open and edit config.txt
 sudo nano /boot/config.txt
 #Add the following line to the file and save
 dtparam=spi=on
 dtoverlay=mcp2515-can0,oscillator=16000000,interrupt=25
 #reboot Raspberry Pi
 reboot 

After rebooting, run the following command：

 dmesg | grep spi0

Run the following command：

sudo ip link set can0 up type can bitrate 1000000
sudo ifconfig can0 txqueuelen 65536
ifconfig

If the device can0 is recognized, it means that the driver was installed successfully

Testing

Install can-utils:

 sudo apt-get install can-utils

Receive data

 candump can0

Send data

 cansend can0 000#11.22.33.44
 #11.22.33.44 is data sent
 #If you need to transmit more dta, you can also extend the data just like this:
 # cansend can0 000#11.22.33.04.70

Examples

【Python examples】

• Go into the directorty of python example：
• Open a terminal as receiver and run the receive.py：

sudo python reveive.py

• Open another terminal as sender and run the send.py：

sudo python send.py

The examples provided is absed on python, please make sure that you have installed the python-can library.
Create a CAN device before you send data,because the front only enables the MCP2515 core

os.system('sudo ip link set can0 type can bitrate 100000')
os.system('sudo ifconfig can0 up')

• Step 1: Connect to the CAN bus
  

can0 = can.interface.Bus(channel = 'can0', bustyp = 'socketcan_ctypes')

• Step 2: Create information
  

msg = can.Message(arbitration_id=0x123, data=[0, 1, 2, 3, 4, 5, 6, 7], extended_id=False)

• Step 3: Send message

can0.send(msg)

• Close the CAN device finally

os.system('sudo ifconfig can0 down')

• Receive data:

msg = can0.recv(10.0)

recv() defines the timeout
for more details, please refer to https://python-can.readthedocs.io/en/stable/interfaces/socketcan.html

【C examples】

• Blocking receive, open the terminal of Raspberry Pi and run the following commands:

cd CAN/c/receive/
make clean
sudo make
sudo ./can_receive

• Send data, open a terminal of Raspberry Pi and run the following commands:

cd CAN/c/receive/
make clean
sudo make
sudo ./can_send

RS485/232

The interface is closed by default, you can modify the config.txt to enable it.

sudo nano /boot/config.txt

Add the following lines to the config.txt file:

 dtoverlay=uart3
 dtoverlay=uart5

Reboot the Raspbery Pi and check if the ports are recognized.

 reboot 
 ls /dev/ttyAMA*

RS232 interfaces use the GPIO5/GPIO4(BCM4/5), recognized as ttyAMA1
RS485 interfaces use the GPIO13/GPIO12(BCM13/12)，recognzied as ttyAMA2

Test

Install minicom and test it with the minicom

 sudo apt-get install minicom
 # RS232
 sudo minicom -D /dev/ttyAMA1
 #RS485
 sudo minicom -D /dev/ttyAMA2

RTC FAN

• Note: Please first connect the FAN and then the power, otherwise you may damage the controller of the fan!
• Note: Please make sure the operation voltage of the cooling fan is the same as the carrier board.

Note that if you want to use the RTC function, please first disable the DSI and CSI.
If you want to use them at the same time, please change the I2C to I2C1 (the right).

You need to modify the codes and driver after changing.
The demo codes use I2C10 by default (the left)

If you need simple use or need to add to your program instead of the kernel, see C and Python demos.[CM4 RTC FAN]

RTC

Open the terminal and modify the config.txt file

sudo nano /boot/config.txt

Add the following lines to the file and modify the audio setting

#Add the lines to the end of file
dtparam=i2c_vc=on
dtoverlay=i2c-rtc,pcf85063a,i2c_csi_dsi
#remove the setting dtparam=audio=on by adding the # to the front of the line
#dtparam=audio=on

Save and reboot the Raspberry Pi.

sudo reboot

Hwclock

Synchronize system clock -> hardware clock

sudo hwclock -w

Synchronize hardware clock -> system clock

sudo hwclock  -s

Note that you need to disable the network synchronization function, otherwise, the time will be changed according to network time.

Set hardware clock:

sudo hwclock --set --date="9/8/2021 16:45:05"

Check the hardware clock.

sudo hwclock -r

Check the version.

sudo hwclock --verbose

Cooling fan

When powered on, the fan will spin for 1 second, then stop for 2 seconds, and then spin again, this is a normal phenomenon
There is currently no official configuration method for fans, there is a third-party configuration method: https://github.com/neg2led/cm4io-fan
This method is released by a third party, not an official release, and we are not responsible for any problems!

 mkdir -p ~/src
 cd ~/src
 git clone https://github.com/neg2led/cm4io-fan.git
 cd cm4io-fan
 sudo chmod 777 install.sh
 sudo  ./install.sh

The device tree overlay has a few options, here's the equivalent of a /boot/overlays/README info section:

 #############################
 Name:   cm4io-fan
 Info:   Raspberry Pi Compute Module 4 IO Board fan controller
 Load:   dtoverlay=cm4io-fan,<param>[=<val>]
 Params: minrpm             RPM target for the fan when the SoC is below 
                            mintemp (default 3500)
        maxrpm              RPM target for the fan when the SoC is above
                            maxtemp (default 5500)
        midtemp             Temperature (in millicelcius) at which the fan
                            begins to speed up (default 50000)
        midtemp_hyst        Temperature delta (in millicelcius) below mintemp
                            at which the fan will drop to minrpm (default 2000)
        maxtemp             Temperature (in millicelcius) at which the fan 
                            will be held at maxrpm (default 70000)
        maxtemp_hyst        Temperature delta (in millicelcius) below maxtemp
                            at which the fan begins to slow down (default 2000)
  #############################

For example, speed up the fan if the temperature is higher than 45°C and set it to maximum value if the temperate is higher than 50°C:

dtoverlay=cm4io-fan,minrpm=500,maxrpm=5000,midtemp=45000,midtemp_hyst=2000,maxtemp=50000,maxtemp_hyst=2000

CSI DSI

Configuration file

CSI and DSI are disabled by default. When using the camera and DSI, it will occupy three I2C devices: I2C-10, I2C-11, and I2C-0.

• Open a terminal and run the following commands:
  

sudo apt-get install p7zip-full -y
wget https://files.waveshare.com/upload/7/75/CM4_dt_blob_Source.zip
7z x CM4_dt_blob.7z -O./CM4_dt_blob
sudo chmod 777 -R CM4_dt_blob
cd CM4_dt_blob/
# If using two cameras and DSI1 execute
sudo dtc -I dts -O dtb -o /boot/dt-blob.bin dt-blob-disp1-double_cam.dts
# In the use of any DSI, HDMI1 no image output, even if you do not connect the DSI screen as long as the corresponding file compiled, that HDMI1 no output
# If you need to restore, delete the corresponding dt-blob.bin can be: sudo rm -rf /boot/dt-blob.bin 
#Execution is complete, power off and restart CM4

New Version (Bullseye)

Camera Config

1. Execute the following commands to edit "/boot/config.txt" file.

   sudo nano /boot/config.txt

2. Block or remove the automatic camera detection statement:

   

3. Add the driver of the camera you are using, here I take IMX219 as an example and connect it to CAM0, and attach the adapter.
   

   

   Model	CAM0 Set Sentence	CAM1 Set Sentence
   OV9281	dtoverlay=ov9281,cam0	dtoverlay=ov9281,cam1
   IMX290/IMX327	dtoverlay=imx290,clock-frequency=37125000,cam0	dtoverlay=imx290,clock-frequency=37125000,cam1
   IMX378	dtoverlay=imx378,cam0	dtoverlay=imx378,cam1
   IMX219	dtoverlay=imx219,cam0	dtoverlay=imx219,cam1
   IMX477	dtoverlay=imx477,cam0	dtoverlay=imx477,cam1
   IMX708	dtoverlay=imx708,cam0	dtoverlay=imx708,cam1

• If you are using the official Raspberry Pi camera and only one camera is connected, there is no need to set the config file. If it is not an official camera, set the "dtoverlay" statement without the "cam" suffix.
• CM4-NANO - only CAM0 is used, so you only need to add "dtoverlay=imx219,cam0".
4. Press Ctrl+o to save the file and then press Enter.

5. Ctrl+x to exit the editor.
6. Reboot the Raspberry Pi.

sudo reboot

Camera Test

1. Enter the camera detection command, you can see that the camera is detected by now.
   

   libcamera-hello --list-cameras
   

   

2. Display the camera screen on the desktop.

libcamera-hello -t

3. Taking photos.

   libcamera-jpeg -o test.jpg
   

4. Record a video of 10s.

   libcamera-vid -t 10000 -o test.h264
   

Other Commands
Check whether the camera is detected:

libcamera-hello --list-cameras

Open the corresponding cameras:

libcamera-hello  --camera 1
libcamera-hello  --camera 0

Take a photo:

libcamera-jpeg -o test.jpg
#Add --camera to specify a camera 

Old Version (Buster)

Camera Config

1. Execute the following command to enter the Raspberry Pi configuration.


sudo raspi-config

2. Choose Interfacing Options and enter.

3. Choose Camera:

4. Choose to enable the camera interface.

5. The system prompts as follows:

6. Back to the main interface, select Finish.

7. Reboot the system.






Camera Test

raspistill -o image.jpg

• Test the recording function:

raspivid -o video.h264 -t 10000

• • Where -t 10000 means recording for 10 seconds, users can adjust according to their own needs.
  • Please refer to CSI.