swaypanion

README

Swaypanion: a companion app for Sway

Swaypanion combines different useful features for sway and similar desktop environments.

Features

• brightness setting

• volume control

Swaypanion daemon

Start the Swaypanion daemon with the swaypanion command.

If you have installed Swaypanion as a package, you may use the systemd service:

systemctl --user start swaypanion

The following command ensures Swaypanion is automatically started when you log in:

systemctl --user enable swaypanion

Swaypanion client

The swaypanionc interactive command-line tool may be used to send commands and receive responses. Use the help command in the swaypanionc command-line shell to get the list of all available commands.

Use ":" as a separator between a command and its argument(s). For instance:

> volume set:50

You may provide partial command names, as long as there is no ambiguity. For instance, b d translates to brightness down, however b u could mean brightness up or brightness unsubscribe: in this situation, you may use b up.

One-shot use

If you provide commands as arguments to the swaypanionc command, these commands are executed, without the integrated shell.

For instance:

$ swaypanionc "volume up" "brightness down"
$ 

Socket

TheSwaypanion daemon listens for connections on a UNIX socket, usually in /run/user/<pid>/swaypanion.sock. Its protocol is simple: when a client connects, Swaypanion waits for a command and its arguments. The arguments separator is the group separator (character 0x1d), the end of command is the end of record character (0x1e).

Notifications

Documentation

Index

• type Stopper
• type Swaypanion
  • func New() (*Swaypanion, error)
  • func (s *Swaypanion) Stop() error

Types

type Stopper

type Stopper interface {
	Stop()
}

type Swaypanion

type Swaypanion struct {
	// contains filtered or unexported fields
}

func New

func New() (*Swaypanion, error)

func (*Swaypanion) Stop

func (s *Swaypanion) Stop() error