Skip to content

Latest commit

 

History

History
215 lines (166 loc) · 6.51 KB

CONTRIBUTING.md

File metadata and controls

215 lines (166 loc) · 6.51 KB
Raw

Contributing to Taranis

Dependencies

PocketBook SDK

The PocketBook SDK is hosted on Github and used to be managed as a Git submodule. Recent versions are distributed as archive in the Github project release artefacts.

GNU Scientific Library

The GNU Scientific Library dependency is used to interpolate hourly temperatures and draw a smooth curve. It must be cross-compiled and installed manually, see instructions below.

Build

Using a container

To build the application for a given version, one can build a Docker image and export an archive containing the ELF file from that image. For example, for a debug build of the most recent tagged version:

VERSION=$(git tag --list 'v*' | sort --version-sort --reverse | head -n 1)
buildah bud -t taranis-build:${VERSION} \
            --build-arg="VERSION=${VERSION}" \
            --build-arg="MESON_ARGS=--buildtype=debug" .
podman run --rm -v ${PWD}:/opt/taranis \
           taranis-build:$VERSION bash -c "cp builddir/artifact.zip /opt/artifact.zip"

Cross-compile on a Debian host

Read the Containerfile to fix potential missing dependencies.

  1. First, clone the source repository and run a script to populate the SDK_6.8.0 directory with the PocketBook SDK:

    ./scripts/install_sdk.sh

  2. Run a script to update SDK paths and generate cross compilation configuration (It will generate the file crossfile_arm.ini used to build):

    ./scripts/generate_cross_compilation_conf.sh

  3. Download, build and install source code of the GNU Scientific Library dependency:

    source ./SDK_6.8.0/env_set.sh
mkdir 3rd-parties
pushd 3rd-parties
wget https://ftp.gnu.org/gnu/gsl/gsl-2.7.1.tar.gz
sha256sum -c gsl-2.7.1.tar.gz.sha256
tar -xzf gsl-2.7.1.tar.gz
pushd gsl-2.7.1
./configure --prefix=$PWD/../../SDK_6.8.0/SDK-B288/usr/arm-obreey-linux-gnueabi/sysroot \
            --host=arm-obreey-linux-gnueabi \
            --build=x86_64-pc-linux-gnu \
            --target=arm-obreey-linux-gnueabi
make -j4
make install
popd
popd

  4. Finally build the application, installer, an archive to install by hand, and compute SHA256 sums:

    meson setup builddir . \
      --cross-file crossfile_arm.ini \
      --buildtype=debug
DESTDIR=artifact meson install -C builddir
meson compile -C builddir installer
meson compile -C builddir archive
meson compile -C builddir sha

Build through GitHub action

The GitHub action build-application allows to simultaneously build the application, its installer, and an archive.

It's mainly used to release the application, see How-to release.

Tooling

Format sources:

ninja -C builddir clang-format

Static analysis:

SCANBUILD=./SDK_6.8.0/SDK-B288/usr/arm-obreey-linux-gnueabi/bin/scan-build ninja -C builddir

Screenshots

Screenshots can be performed through the task menu of an e-reader, and conversion can be done using ImageMagick convert script; For example:

convert /media/matthias/Vivlio/screens/scr0002.bmp \
        -scale 20% -bordercolor pink -border 5 \
        docs/screenshot-hourly-forecast.jpg

Debugging

Log file

The application can be started with the --verbose command line argument to generate a detailed log file. The file path is of the form /mnt/ext1/system/state/taranis.log but may vary depending on the use of profiles.

To specify command line arguments rather use a terminal like pbterm or use Desktop integration.

SSH connection with device

Use the USB connection (it's the last time you'll use it 🎆) to create a file /mnt/ext1/applications/SSHServer.app on the device with following content where one must adapt the IP address to match the SSH client address (a more complete version is available from the scripts directory):

#!/bin/sh

TRUSTED_CLIENT_IP=192.168.1.22
PORT=8222

dropbear -p ${PORT} -G ${TRUSTED_CLIENT_IP}

Make sure Wifi is enabled on the device, identify its IP address (using PBTerm and ipconfig for example, let's say that in our case it's 192.168.1.34), and start the "SSHServer" application just created.

⚠️ Note that from now on (until a reboot or an explicit kill of the dropbear process) the device will be running a SSH server accepting unauthenticated connections on port 8222 from the 192.168.1.22 IP address.

Then, on the client, create or complete the file ~/.ssh/config:

Host 192.168.1.34
     User reader
     PubkeyAcceptedAlgorithms +ssh-rsa
     HostkeyAlgorithms +ssh-rsa
     Port 8222

Finally test the connection from the client with ssh 192.168.1.34 ash. Beware that there's no allocated pseudo-terminal…

Since there's no SFTP server on the device, to copy files from the client to the device one must redirect standard input to the target file. For example, to copy taranis executable after a build:

cat builddir/artifact/taranis.app | \
  ssh 192.168.1.34 '( cat - > /mnt/ext1/applications/taranis.app )'

(make sure the file isn't opened on the device side).

To track taranis logs:

ssh 192.168.1.34 tail -f /mnt/ext1/system/profiles/Matthias/state/taranis.log

Remote debugging

One must first start gdbserver on the e-reader:

  1. Install pbterm
  2. Start taranis.app
  3. Press the "Home" key to go back to the "desktop"
  4. Start pbterm
  5. Run TARANIS_PID=$(pgrep taranis.app) to identify the process running taranis.app, say 1423
  6. Run gdbserver --attach :10002 ${TARANIS_PID}

The e-reader must be connected to Internet and its IP address must be known (eg start ipconfig in pbterm). It is recommended to disable automatic poweroff.

On the host computer, start a shell with current working directory the root directory of a Git clone of taranis repository. Then start GDB:

./SDK_6.8.0/SDK-B288/usr/bin/arm-linux-gdb -q taranis.app

Under GDB, run target remote 192.168.1.34:10002 where the IP address must be updated to the address of the e-reader.

References