aircheq

Recorder for Japanese streaming radio service

Configure

to run, you need to set NHK API key. edit the configuration file

    $EDITOR ~/.aircheq/config.toml

[radiru]
area = YOUR_AREA_CODE_AS_A_NUMBER
# eg.
# area = 130

api_key = 'PUT_NHK_API_KEY_AS_STR_HERE'

you can also change a path where recorded saved

[general]
recorded_dir = "/path/to/your/recorded/directory"

Run by Docker Compose

    cd /path/to/project_root

    # edit the config
    cp ./config.toml.skel ./docker/config/config.toml
    $EDITOR ./docker/config/config.toml

    # add your UID and GID to .env file for docker
    touch ./docker/.env
    echo HOST_UID=$(id -u $USER) >> ./docker/.env
    echo HOST_GID=$(id -g $USER) >> ./docker/.env

    # execute
    docker-compose -f ./docker-compose.build.yml build
    docker-compose -f ./docker-compose.yml up -d

    # stop
    docker-compose -f ./docker-compose.yml down

Run on local environment

Required

• Python >= 3.9

• poetry

• ffmpeg (as a global package)

• NHK API KEY (need to register)

Optional

• RTMPDump (as a global package)
• swfextract (as a global package)
• webpack (as a global package, to build WUI from source)

Install

cd /path/to/project_root/
uv sync

Run

    cd /path/to/project_root/
    .venv/bin/python -m aircheq        # Start Operator
    .venv/bin/python -m aircheq.web    # Start Web Server

you need to configure ~/.aircheq/config.toml

Migrate from config.py to config.toml

    cd /path/to/project_root/
    poetry run python -m aircheq.cli migrate-config ~/.aircheq/config.py  ~/.aircheq/config.toml

(Optional) build WUI from source

# install wui requirements 
cd aircheq/web/aircheq_wui/
npm install
webpack