hyperion-remote:
Version : 2.0.16-beta.1+PR1595 ((HEAD detached at pull/1595/merge) (GitHub-af07757/e44ff2e-1679942179))
build time: Mar 27 2023 19:35:42
Usage: hyperion-remote [options]
Application to send a command to hyperion using the JSON interface
Options:
-a, --address <address> The hostname or IP-address
(IPv4 or IPv6) of the
hyperion server.
Default port: 19444.
Sample addresses:
Host : hyperion.fritz.box
IPv4 : 127.0.0.1:19444
IPv6 : [2001:1:2:3:4:5:6:7]
[default: 127.0.0.1]
-t, --token <token> If authorization tokens
are required, this token is
used
-I, --instance <instance> Select a specific target
instance by name for your
command. By default it uses
always the first instance
-p, --priority <priority> Used to the provided
priority channel (suggested
2-99) [default: 50]
-d, --duration <duration> Specify how long the LEDs
should be switched on in
milliseconds [default:
infinity]
-c, --color <color> Set all LEDs to a constant
color (either RRGGBB hex
getColors or a color name.
The color may be repeated
multiple time like:
RRGGBBRRGGBB)
-i, --image <image> Set the LEDs to the colors
according to the given
image file
-e, --effect <effect> Enable the effect with the
given name
--effectFile <effectFile> Arguments to use in
combination with
--createEffect
--effectArgs <effectArgs> Arguments to use in
combination with the
specified effect. Should be
a JSON object string.
--createEffect <createEffect> Write a new JSON Effect
configuration file.
First parameter = Effect
name.
Second parameter = Effect
file (--effectFile).
Last parameter = Effect
arguments (--effectArgs.)
--deleteEffect <deleteEffect> Delete a custom created
JSON Effect configuration
file.
-x, --clear Clear data for the
priority channel provided
by the -p option
--clearall Clear data for all active
priority channels
-E, --enable <enable> Enable the Component with
the given name. Available
Components are [SMOOTHING,
BLACKBORDER, FORWARDER,
BOBLIGHTSERVER, GRABBER,
V4L, AUDIO, LEDDEVICE]
-D, --disable <disable> Disable the Component with
the given name. Available
Components are [SMOOTHING,
BLACKBORDER, FORWARDER,
BOBLIGHTSERVER, GRABBER,
V4L, AUDIO, LEDDEVICE]
-q, --qualifier <qualifier> Identifier(qualifier) of
the adjustment to set
-L, --brightness <brightness> Set the brightness gain of
the LEDs
--brightnessCompensation <brightnessCompensation> Set the brightness
compensation
-n, --backlightThreshold <backlightThreshold> threshold for activating
backlight (minimum
brightness)
--backlightColored <backlightColored> 0 = white backlight; 1 =
colored backlight
-g, --gamma <gamma> Set the overall gamma of
the LEDs
-R, --redAdjustment <redAdjustment> Set the adjustment of the
red color (requires colors
in hex format as RRGGBB)
-G, --greenAdjustment <greenAdjustment> Set the adjustment of the
green color (requires
colors in hex format as
RRGGBB)
-B, --blueAdjustment <blueAdjustment> Set the adjustment of the
blue color (requires colors
in hex format as RRGGBB)
-C, --cyanAdjustment <cyanAdjustment> Set the adjustment of the
cyan color (requires colors
in hex format as RRGGBB)
-M, --magentaAdjustment <magentaAdjustment> Set the adjustment of the
magenta color (requires
colors in hex format as
RRGGBB)
-Y, --yellowAdjustment <yellowAdjustment> Set the adjustment of the
yellow color (requires
colors in hex format as
RRGGBB)
-W, --whiteAdjustment <whiteAdjustment> Set the adjustment of the
white color (requires
colors in hex format as
RRGGBB)
-b, --blackAdjustment <blackAdjustment> Set the adjustment of the
black color (requires
colors in hex format as
RRGGBB)
-m, --ledMapping <ledMapping> Set the method for image
to led mapping valid
values: multi color_mean,
uni-color_mean
-V, --videoMode <videoMode> Set the video mode valid
values: 2D, 3DSBS, 3DTAB
--sourceSelect <sourceSelect> Set current active
priority channel and
deactivate auto source
switching
--sourceAutoSelect Enables auto source, if
disabled prio by manual
selecting input source
--off Deactivates hyperion
--on Activates hyperion
--configGet Print the current loaded
Hyperion configuration file
--schemaGet Print the JSON schema for
Hyperion configuration
--configSet <configSet> Write to the actual loaded
configuration file. Should
be a JSON object string.
-l, --list List server info and
active effects with
priority and duration
-s, --sysinfo Show system info
--suspend Suspend Hyperion. Stop all
instances and components
--resume Resume Hyperion. Start all
instances and components
--toggleSuspend Toggle between Suspend and
Resume. First request will
trigger suspend
--idle Put Hyperion in Idle mode,
i.e. all instances,
components will be disabled
besides the output
processing (LED-devices,
smoothing).
--toggleIdle Toggle between Idle and
Working mode. First request
will trigger Idle mode
--restart Restart Hyperion
--print Print the JSON input and
output messages on stdout
--debug Enable debug logging
-h, --help Show this help message and
exit