Batocera.linux - Wiki

Only Cores That Matter

User Tools

Site Tools


usage_of_batocera-settings

Usage of: batocera-settings

Introduction

batocera-settings is a commandline tool that can work with regular config files and read/write/change it's content. There are keys and values stored in a file like /userdata/system/batocera.conf.

  • It's recommended to use ## This is a text comment for text comments
  • It's recommended to use #enable.godmode=hallelujah for commenting values
  • It's recommended to descripe content and functions in text form
  • It's recommended to add content in sections
  • It's recommended to use the form key.description=value

Down here is a small excerpt of a config file

# ------------ B - Network ------------ #
## Set system hostname
system.hostname=BATOCERA
## Activate wifi (0,1)
wifi.enabled=0
## Wifi SSID (string)
#wifi.ssid=new ssid
## Wifi KEY (string)
## after rebooting the batocera.linux, the "new key" is replace by a hidden value "enc:xxxxx"
## you can edit the "enc:xxxxx" value to replace by a clear value, it will be updated again at the following reboot
## Escape your special chars (# ; $) with a backslash : $ => \$
#wifi.key=new key

Commands and Expressions

batocera-setting is utilized by parameters parsed. These parameters can be used in the long and in the short format. It's a relict of RecalBox times thus the expression python batoceraSetting.py -command load -key user.key is used till today but arguments are now parsed to batocera-settings and it's not recommended to use this old style anymore.

As batocera-settings is more modern and supports read/write/change of value let's see how the command line works:

  • BATOCERA Long format (Unix Style), recommended
    • batocera-settings --command load --key your.key
  • BATOCERA Short format, recommended
    • batocera-settings load your.key
--command --key --value alias commands
load your.key get, read
write your.key keyvalue set, save
status your.key stat
comment your.key disable, deactivate
uncomment your.key enable, activate

Error code handling

Whenever batocera-settings was called you will receive an exit code number. This will help to identify errors - morover for debugging you can use the status command to held usefull output.

File and Key/Values error
Error Code Error code explaination Troubleshooting
EC 0 No Error, value found 8-) You made it!
EC 1 General error, e.g. command line error 8-o Check your command line for correct parameters
EC 2 File error, e.g. the config file is not available m( Check file path and r/w access to it
EC 10 Value error, key found but value is empty 8-o Unusual setup but no error at all
EC 11 Value error, key found but it is commented out :-( Activate the key entry by uncomment command
EC 12 Key not found m( Add the key by manual or check your command line for typos

Handling in scripts

I present here some short scripts, to show you how to make batocera-settings work in your script. As I'm more confident in shell scripting I give you just some small exampels in shell script.

  1. bash: Obtain value
  2. bash: Activate UART in /boot/config.txt
  3. bash: Set a new key
  4. python: Obtain a value

USE AT YOUR OWN RISK 8-)

1. bash: Obtain a value

obtain_value.sh
#!/bin/bash
#This is an example file how batocera-settings can be utilized
#to read a value out from /userdata/system/batocera.conf
 
value="$(batocera-settings --command load --key power.switch.device)"
ret=$?
if [[ $ret -eq 0 ]]; then
    echo "Power Switch detected: '$value'"
else
    echo "No Power Switch detected!"
fi

2. bash: Activate UART in ''/boot/config.txt''

activate_uart.sh
#!/bin/bash
#This is an example file how batocera-settings can be utilized
#to activate UART in /boot/config.txt
 
batocera-settings /boot/config.txt --command uncomment --key enable_uart
ret=$?
if [[ $ret -eq 0 ]]; then
    echo "UART activated, uncommented enable_uart"
elif [[ $ret -eq 2 ]]; then
    echo "File is write protected!"
    echo "I make boot-partition writeable"
    mount -o remount, rw /boot
    echo "Please restart script"
else
    echo "Key: enable_uart not found"
    echo "Not a Raspberry System?"
fi

3. bash: Set a new key

activate_uart.sh
#!/bin/bash
#This is an example file how batocera-settings can be utilized
#to set a new key in /userdata/system/batocera.conf
 
value=$(batocera-settings --command write --key core.PS4.emulator --value SONY4EVER
ret=$?
if [[ $ret -eq 0 ]]; then
    echo "PS4 core enabled!"
elif [[ $ret -eq 12 ]]; then
    echo "Key not found! - I add it"
    echo "core.PS4.emulator=" >> /userdata/system/batocera.conf
 
    echo "Please restart script!"
else
    echo "Annother error occoured!"
fi

4. python: Obtain a key

FIXME

obtain_value.py
#!/usr/bin/python
# -*- coding: utf-8 -*-
#This is an example file how batocera-settings can be utilized
#to read a value out from /userdata/system/batocera.conf with python
 
import subprocess
 
value = (subprocess.check_output(['batocera-settings', 'get', 'power.switch.device']))
if value:
    print "Power Switch Detected: ", value
else:
    print "No power switch detected!"
usage_of_batocera-settings.txt · Last modified: 2020/01/28 20:52 by genetik57