SOCRANOP-SESSION-SERVICE(1)

NAME
socranop-session-service - session D-Bus service for socranop

SYNOPSIS
socranop-session-service (--help|--version)
socranop-session-service [--verbose]

DESCRIPTION

The socranop-session-service D-Bus service is bus activated, so it does not need to be run explicity in normal operation.

The D-Bus service fulfils two main functions:

stand in for the mixer state
    As the Notepad series of mixers does not appear to have a USB command to query the state which can be set with a USB command, the D-Bus service remembers the hardware state to provide a halfway sane behaviour.

notify other processes of mixer state changes
    If you have e.g. a socranop-gui window open, and change the mixer state from the command line with socranop-ctl --set, the socranop-gui window will show that state change immediately.

OPTIONS

If no options are given on the command line, socranop-session-service will just start as a D-Bus service and keep running until a D-Bus client requests it to shut down.

--help
    Print command line help and exit.

--version
    Print the program version and exit.

(-v|--verbose)
    Make the program output more information. Helpful for debugging.

EXIT STATUS
If successful, returns 0. Non-0 exit codes indicate an error.

ENVIRONMENT

XDG_CONFIG_HOME
    See the state file description in the FILES section below.

FILES

/dev/bus/usb/NNN/MMM
    The USB device file corresponding to the Notepad mixer. NNN and MMM are decimal numbers. For more information on device permission setup, see https://github.com/socratools/socranop/blob/main/PERMISSIONS.md

~/.config/${PACKAGE}/state/*.state
    The state file is used to keep track of the state the device has been set to.

    If the XDG_CONFIG_HOME environment variable is set when socranop-session-service starts, socranop-session-service uses its value instead of the ~/.config part of the state file location.

    Note that socranop-session-service ignores XDG_CONFIG_HOME values passed via D-Bus, which means that all D-Bus clients use the same state file by going through the D-Bus service, regardless of the D-Bus clients' XDG_CONFIG_HOME value.

NOTES
The USB device file must be readable and writable for the socranop-session-service process. For more information on permission setup, see https://github.com/socratools/socranop/blob/main/PERMISSIONS.md

BUGS
For reading about known bugs and for filing new bugs, please go visit https://github.com/socratools/socranop/issues.

EXAMPLES
Usually, socranop-session-service will be invoked by D-Bus bus activation. This means you will rarely find yourself explictly running socranop-session-service. The rare exception could be if something behaves weirdly and you want to help debug the problem by having socranop-session-service print a few more messages than usual:
    [user@host ~]$$ socranop-session-service --verbose
    AbstractDirs.__init__ UsrLocalDirs(chroot=None, prefix='/usr/local', datadir='/usr/local/share', statedir='/home/user/.config/socranop/state') chroot=None
    [... several dozen lines cut ...]
    <socranop.notepad.Notepad_12fx object at 0x7fadab48abb0> using existing stateFile /home/iser/.config/socranop/state/Notepad-12FX.state
    Switching USB audio input to MASTER_L_R
    Sending array('B', [0, 0, 4, 0, 3, 0, 0, 0])
    self.stateFile PosixPath('/home/user/.config/socranop/state/Notepad-12FX.state')
    Presenting Notepad-12FX (fw v1.09) on the session bus as /io/github/socratools/socranop/0
    _

SEE ALSO
socranop-ctl(1), socranop-gui(1), https://github.com/socratools/socranop/blob/main/PERMISSIONS.md