The open source software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
This HowTo describes how to use the Software-Development-Kit (SDK) for the CC100 based on docker.
All steps up to 3.1) need a connection to the internet. The build can be done without a network connection.
The cc100-builder image comes with a ready to use toolchain and the build tool ptxdist. In order to simplify the interaction with docker and ptxdist we provide a make wrapper including all steps to create CC100 firmware images and beyond.
The start into the embedded linux world requires substantial technical know-how to have success. Therefore WAGO recommends familiarity with the following topics for the future embedded linux developer:
- Linux-OS /- working on command line interface(CLI)
- writing Makefile, C or C++ code, shell-scripts.
- Cross-Platform-Development.
Helpful when heard about:
- Realtime operating systems
- PTXdist,
- ARM architecture
- Bootloader
Make sure that you install GIT version >= 1.8.2
sudo apt install git
Due to the fact that the repository contains files over 50MB you need the GIT large file support extension for GIT before you clone the repository.
sudo apt install git-lfs && git lfs install
Make sure that docker and make are installed on the host system.
To install docker, please refer to the instructions depending on your host system, e.g for Ubuntu use https://docs.docker.com/install/linux/docker-ce/ubuntu/.
Make sure docker can be run without root privileged. Refer to https://docs.docker.com/engine/install/linux-postinstall/ for further information.
sudo apt install make
The cc100-builder image bases on the sdk-builder image defined in https://github.com/WAGO/sdk-builder. Docker will pull the corresponding base image during the build process.
If you prefer to build the sdk-builder image manually follow instruction provided in the repository description. Pay attention to the sdk-builder version as each fw release is bound to exactly one sdk-builder release.
We provide one tag for each firmware(FW) release. You can download specific FW versions in the release section. Alternatively you may use git to clone the repository.
git clone [email protected]:WAGO/cc100-firmware-sdk.git && cd cc100-firmware-sdk
Afterward you can checkout a specific release.
git checkout <fw release>
make builder
make init
Alternatively you can also run cc100-builder in bash mode (make bash) and enter the following commands.
ptxdist select configs/cc100/ptxconfig_generic && \
ptxdist platform configs/cc100/platformconfig && \
ptxdist toolchain /opt/gcc-Toolchain-2022.08-wago.1/LINARO.Toolchain-2022.08-wago.1/arm-linux-gnueabihf/bin/ && \
ptxdist clean -q
This step is optional, step 4.) includes this one. But using this step, everything that follows can be done without a connection to the internet.
make get
Alternatively you can also run pfc-builder in bash mode (make bash) and enter the following command.
ptxdist get -q
make build
Alternatively you can also run cc100-builder in bash mode (make bash) and enter the following command.
ptxdist go -q
started : ethtool.get
finished: ethtool.get
started : ethtool.extract
finished: ethtool.extract
started : base.get
finished: base.get
started : base.extract
finished: base.extract
started : kernel-header.get
finished: kernel-header.get
started : kernel-header.extract
...
Now it's probably time to go home for the day. Even on reasonably fast machines the time to build the CC100 firmware takes from 30 minutes up to a few hours. Another possibility is to read "How to become a PTXdist Guru" http://public.pengutronix.de/software/ptxdist/appnotes/ in the meantime.
Note that the SD card image is also provided in the release section for each FW. To generate those images run:
make images
Alternatively you can also run cc100-builder in bash (make bash) mode and enter the following command.
ptxdist images -q
Afterwards you should find the firmware image "sd.hdimg" in folder ~/ptxproj/platform-cc100/images/ .
It is possible to create the WUP for an easier update of the firmware via ethernet. To generate the WUP run:
make wup
Alternatively you can also run pfc-builder in bash (make bash) mode and enter the following command.
make wup
Documentation on how to use the WUP can be found in the pfc manual (12.2.1): https://www.wago.com/de/sps/controller-pfc200/p/750-8212#downloads.
RAUC uses a certificate based approach to authenticate the origin of a bundle. To ease creating of WUP files during development, the BSP contains test certificates. In order to use RAUC's authentication mechanism to ensure the origin of a bundle, it is stricly recommended to to use custom certificates. A HowTo for this can be found here: https://github.com/WAGO/pfc-howtos/tree/master/HowTo_GenerateWUPFile.
If you are working in a virtual machine on a windows host and you feel unsafe using dd on the virtual machine just follow the follwing steps:
- Copy firmware image "sd.hdimg" to your windows host
- Download, install and use "Win32 Disk imager.exe"...
- Disable desktops "automount-open" feature
gsettings set org.gnome.desktop.media-handling automount true && \
gsettings set org.gnome.desktop.media-handling automount-open false
- Identify SD-Card
In this example we will identify /dev/sde as out sd card device.
>mount
/dev/sda1 on / type ext4 (rw,errors=remount-ro)
proc on /proc type proc (rw,noexec,nosuid,nodev)
sysfs on /sys type sysfs (rw,noexec,nosuid,nodev)
....
/dev/sde1 on /media/BOOT type vfat (rw,nosuid,nodev,uid=1000,gid=1000,shortname=mixed,dmask=0077,utf8=1,showexec,flush,uhelper=udisks)
/dev/sde2 on /media/disk type ext3 (rw,nosuid,nodev,uhelper=udisks)
>umount /dev/sde1
>umount /dev/sde2
- Copy "sd.hdimg" to SD-Card
cd <workspace>/ptxproj/platform-cc100/images
Identify your sd card device, this will be needed as parameter for dd. 'of=[/dev/[sd card device].`
We will use /dev/sde for example.
>sudo dd if=sd.hdimg of=/dev/sde
[sudo] password for <user>:
399360+0 Datasets in
399360+0 Datasets out
204427320 Bytes (204 MB) copied, 73.5553 s, 2.8 MB/s
CC100 boot device order checks SD-Card slot before internal NAND.
By default, CC100 tries to find a DHCP-Server to retrieve an IP-Address.
- PowerOff CC100
- Insert SD-Card with custom-image
- PowerOn CC100
| User | Password |
|---|---|
| root | wago |
| admin | wago |
| user | user |
"CC100-uvwxyz"
Where 'uvwxyz' is the last part of eth0's MAC-ID in capital letters.
- Operate in "switched-mode"
- DHCP-Client request dynamic Ip-Address from DHCP Server.
- SSH-Daemon is enabled.
- https-Server is enabled.
Is no more owned by operating system Linux, so it has to be configured to be the console output.
This can be easily be done via the web-confuguration.
-
Variant A: Web-Based-Management(WBM) via https
B.0) Obtain actual IP address
B.1) Open WBM in browser(https://)
B.2) Ignore x509 certificate warning and proceed.
B.3) Now you should be able to view and change settings.\ -
Variant B: Command-Line-Interface(CLI) via ssh
C.0) Obtain actual IP address
C.1) Start ssh-client, such as putty
C.2) Open ssh session to cc100 )
C.3) Ignore 'PuTTY Security Alert' and proceed.
C.4) Login as user/password (Default: "root"/"wago")
C.5) Start WAGO config tool "/usr/sbin/cbm"\
Read "How to become a PTXdist Guru" and other ressources at http://public.pengutronix.de/software/ptxdist/appnotes/
Building a complete firmware image is necessary exactly one time, to extract
and build the whole system. For your daily work, you usually will work on package level.
After entering the cc100-builder (make bash), you can:
- Rebuild a package
>ptxdist clean <pkg-name> && ptxdist targetinstall <pkg-name>
- Copy "binaries" somehow by hand into CC100's file system, and make them executable.
- Transfer install-package ".ipk" somehow into CC100 file system and call
>opkg install <pkg-name>.ipk
- Utilize Web-Based-Management(WBM) feature "Software-Upload" to upload and apply ".ipk".
CAUTION:
Every binary or installation package(.ipk) is generated for a specific firmware version,
do not mix up different versions.
Open 4 shell sessions on your development host.
- First shell used to open source code files within an editor like vim or gedit
cd /wago/ptxproj/src/kbusdemo && gedit kbusdemo1.c
- Second shell inside cc100-builder (
make bash) used to “clean” and “build” the ptxdist package
ptxdist clean kbusdemo && ptxdist targetinstall kbusdemo
- Third shell used to transfer executable to CC100.
scp kbusdemo1 root@<ip or hostname>:/usr/bin/kbusdemo1
- Fourth shell used to manage and control the CC100 via ssh
>ssh root@<ip or hostname>
>cd /usr/bin
>chmod +x kbusdemo1
>./kbusdemo1
For the next round trip: 1. Switch to the first shell and use the cursor-up-key to call the last command… 2. Modify source code and save changes 3. Switch to the second shell and use the cursor-up-key to call the last command… 4. Rebuild executables 5. Switch to the third shell and use the cursor-up-key to call the last command… 6. Transfer executables to CC100 7. Switch to the fourth shell and use the cursor-up-key to call the last command… 8. Start executable on CC100
10.2) Using Web-Based-Management(WBM) feature "Software-Upload" for upload and applying IPK packages
Tool "ptxdist" automatically generates an ".ipk" file for each package during build process.
https://ip.address.assigned.by.dhcp
Ignore Cert-Warning ...
10.2.2) Select "Software-Upload" in left hand "Navigation" pane, You will be requested to authenticate!
Login as "admin" with password "wago" (default)
Browse to folder "~/wago/ptxproj/platform-cc100/packages/"
Select package to install or update, here "kbusdemo_0.3_arm.ipk".
Transfers selected file into CC100 file system and show button [Activate].
Internally WBM just calls:
cd /home/ && opkg install kbusdemo_0.3_arm.ipk
Depending on type of package a restart of CC100 may be required.
It may be a good idea to setup a build server for a nightly build to check dependencies and consistency and do some unit testing in an automated way.
| Command | Description |
|---|---|
| builder | create docker image cc100-builder |
| init | initialize PTXdist project in ptxproj directory |
| get | download all OSS packages |
| offline-get | verify that all OSS packages are downloaded |
| build | build all packages |
| offline-build | build all packages without network access |
| images | create SD card image |
| wup | create WUP file |
| bash | runs cc100-builder in bash mode |