3 Commits

Author SHA1 Message Date
58866b794b implement info command
upd help mds
2026-02-11 21:47:56 +00:00
32a09db1a4 unexport client 2026-02-11 21:25:40 +00:00
106f896c45 upd strip send docstrings/help messages 2026-02-11 09:26:23 +00:00
20 changed files with 163 additions and 98 deletions

View File

@@ -46,9 +46,10 @@ type CLI struct {
Version VersionFlag `help:"Print x32-cli version information and quit" name:"version" short:"v"`
Completion kongcompletion.Completion `help:"Generate shell completion scripts." cmd:"" aliases:"c"`
Completion kongcompletion.Completion `help:"Generate shell completion scripts." cmd:""`
Info InfoCmd `help:"Print mixer information." cmd:""`
Raw RawCmd `help:"Send raw OSC messages to the mixer." cmd:""`
Raw RawCmd `help:"Send raw OSC messages to the mixer." cmd:"" group:"Raw"`
Main MainCmdGroup `help:"Control the Main L/R output" cmd:"" group:"Main"`
Mainmono MainMonoCmdGroup `help:"Control the Main Mono output" cmd:"" group:"MainMono"`
Matrix MatrixCmdGroup `help:"Control the matrix outputs." cmd:"" group:"Matrix"`

18
cmd/x32-cli/info.go Normal file
View File

@@ -0,0 +1,18 @@
package main
import "fmt"
type InfoCmd struct {
}
func (c *InfoCmd) Run(ctx *context) error {
fmt.Fprintf(
ctx.Out,
"Host: %s | Name: %s | Model: %s | Firmware: %s\n",
ctx.Client.Info.Host,
ctx.Client.Info.Name,
ctx.Client.Info.Model,
ctx.Client.Info.Firmware,
)
return nil
}

View File

@@ -140,27 +140,41 @@ func (cmd *StripFadeoutCmd) Run(ctx *context, strip *StripCmdGroup) error {
}
}
// StripSendCmd defines the command for getting or setting the send level for a specific bus on a strip, allowing users to control the level of the signal being sent from the strip to a particular bus.
// StripSendCmd defines the command for getting or setting the auxiliary send level
// for a specific send destination (mix bus) on a strip.
type StripSendCmd struct {
BusNum int `arg:"" help:"The bus number to get or set the send level for."`
SendIndex int `arg:"" help:"The index of the send destination (mix bus). (1-based indexing)"`
Level *float64 `arg:"" help:"The send level to set (in dB)." optional:""`
}
// Run executes the StripSendCmd command, either retrieving the current send level for the specified bus on the strip or setting it based on the provided argument.
// Run executes the StripSendCmd command, either retrieving the current send level for the specified send destination
// or setting it based on the provided argument.
func (cmd *StripSendCmd) Run(ctx *context, strip *StripCmdGroup) error {
if cmd.Level == nil {
resp, err := ctx.Client.Strip.SendLevel(strip.Index.Index, cmd.BusNum)
resp, err := ctx.Client.Strip.SendLevel(strip.Index.Index, cmd.SendIndex)
if err != nil {
return fmt.Errorf("failed to get send level: %w", err)
}
fmt.Fprintf(ctx.Out, "Strip %d send level for bus %d: %.2f dB\n", strip.Index.Index, cmd.BusNum, resp)
fmt.Fprintf(
ctx.Out,
"Strip %d send %d level: %.2f dB\n",
strip.Index.Index,
cmd.SendIndex,
resp,
)
return nil
}
if err := ctx.Client.Strip.SetSendLevel(strip.Index.Index, cmd.BusNum, *cmd.Level); err != nil {
if err := ctx.Client.Strip.SetSendLevel(strip.Index.Index, cmd.SendIndex, *cmd.Level); err != nil {
return fmt.Errorf("failed to set send level: %w", err)
}
fmt.Fprintf(ctx.Out, "Strip %d send level for bus %d set to: %.2f dB\n", strip.Index.Index, cmd.BusNum, *cmd.Level)
fmt.Fprintf(
ctx.Out,
"Strip %d send %d level set to: %.2f dB\n",
strip.Index.Index,
cmd.SendIndex,
*cmd.Level,
)
return nil
}

View File

@@ -46,9 +46,10 @@ type CLI struct {
Version VersionFlag `help:"Print xair-cli version information and quit" name:"version" short:"v"`
Completion kongcompletion.Completion `help:"Generate shell completion scripts." cmd:"" aliases:"c"`
Completion kongcompletion.Completion `help:"Generate shell completion scripts." cmd:""`
Info InfoCmd `help:"Print mixer information." cmd:""`
Raw RawCmd `help:"Send raw OSC messages to the mixer." cmd:""`
Raw RawCmd `help:"Send raw OSC messages to the mixer." cmd:"" group:"Raw"`
Main MainCmdGroup `help:"Control the Main L/R output" cmd:"" group:"Main"`
Strip StripCmdGroup `help:"Control the strips." cmd:"" group:"Strip"`
Bus BusCmdGroup `help:"Control the buses." cmd:"" group:"Bus"`

18
cmd/xair-cli/info.go Normal file
View File

@@ -0,0 +1,18 @@
package main
import "fmt"
type InfoCmd struct {
}
func (c *InfoCmd) Run(ctx *context) error {
fmt.Fprintf(
ctx.Out,
"Host: %s | Name: %s | Model: %s | Firmware: %s\n",
ctx.Client.Info.Host,
ctx.Client.Info.Name,
ctx.Client.Info.Model,
ctx.Client.Info.Firmware,
)
return nil
}

View File

@@ -140,27 +140,29 @@ func (cmd *StripFadeoutCmd) Run(ctx *context, strip *StripCmdGroup) error {
}
}
// StripSendCmd defines the command for getting or setting the send level for a specific bus on a strip, allowing users to control the level of the signal being sent from the strip to a particular bus.
// StripSendCmd defines the command for getting or setting the auxiliary send level
// for a specific send destination (mix bus or effects channel) on a strip.
type StripSendCmd struct {
BusNum int `arg:"" help:"The bus number to get or set the send level for."`
SendIndex int `arg:"" help:"The index of the send destination (mix bus or effects channel). (1-based indexing)"`
Level *float64 `arg:"" help:"The send level to set (in dB)." optional:""`
}
// Run executes the StripSendCmd command, either retrieving the current send level for the specified bus on the strip or setting it based on the provided argument.
// Run executes the StripSendCmd command, either retrieving the current send level for the specified destination
// or setting it based on the provided argument.
func (cmd *StripSendCmd) Run(ctx *context, strip *StripCmdGroup) error {
if cmd.Level == nil {
resp, err := ctx.Client.Strip.SendLevel(strip.Index.Index, cmd.BusNum)
resp, err := ctx.Client.Strip.SendLevel(strip.Index.Index, cmd.SendIndex)
if err != nil {
return fmt.Errorf("failed to get send level: %w", err)
}
fmt.Fprintf(ctx.Out, "Strip %d send level for bus %d: %.2f dB\n", strip.Index.Index, cmd.BusNum, resp)
fmt.Fprintf(ctx.Out, "Strip %d send %d level: %.2f dB\n", strip.Index.Index, cmd.SendIndex, resp)
return nil
}
if err := ctx.Client.Strip.SetSendLevel(strip.Index.Index, cmd.BusNum, *cmd.Level); err != nil {
if err := ctx.Client.Strip.SetSendLevel(strip.Index.Index, cmd.SendIndex, *cmd.Level); err != nil {
return fmt.Errorf("failed to set send level: %w", err)
}
fmt.Fprintf(ctx.Out, "Strip %d send level for bus %d set to: %.2f dB\n", strip.Index.Index, cmd.BusNum, *cmd.Level)
fmt.Fprintf(ctx.Out, "Strip %d send %d level set to: %.2f dB\n", strip.Index.Index, cmd.SendIndex, *cmd.Level)
return nil
}

View File

@@ -3,14 +3,14 @@ package xair
import "fmt"
type Bus struct {
client *Client
client *client
baseAddress string
Eq *Eq
Comp *Comp
}
// newBus creates a new Bus instance
func newBus(c *Client) *Bus {
func newBus(c *client) *Bus {
return &Bus{
client: c,
baseAddress: c.addressMap["bus"],

View File

@@ -9,13 +9,9 @@ import (
"github.com/hypebeast/go-osc/osc"
)
type Client struct {
*engine
}
// XAirClient is a client for controlling XAir mixers
type XAirClient struct {
Client
client
Main *Main
Strip *Strip
Bus *Bus
@@ -24,9 +20,29 @@ type XAirClient struct {
DCA *DCA
}
// NewXAirClient creates a new XAirClient instance with optional engine configuration
func NewXAirClient(mixerIP string, mixerPort int, opts ...EngineOption) (*XAirClient, error) {
e, err := newEngine(mixerIP, mixerPort, kindXAir, opts...)
if err != nil {
return nil, err
}
c := &XAirClient{
client: client{e, InfoResponse{}},
}
c.Main = newMainStereo(&c.client)
c.Strip = newStrip(&c.client)
c.Bus = newBus(&c.client)
c.HeadAmp = newHeadAmp(&c.client)
c.Snapshot = newSnapshot(&c.client)
c.DCA = newDCA(&c.client)
return c, nil
}
// X32Client is a client for controlling X32 mixers
type X32Client struct {
Client
client
Main *Main
MainMono *Main
Matrix *Matrix
@@ -45,48 +61,33 @@ func NewX32Client(mixerIP string, mixerPort int, opts ...EngineOption) (*X32Clie
}
c := &X32Client{
Client: Client{e},
client: client{e, InfoResponse{}},
}
c.Main = newMainStereo(&c.Client)
c.MainMono = newMainMono(&c.Client)
c.Matrix = newMatrix(&c.Client)
c.Strip = newStrip(&c.Client)
c.Bus = newBus(&c.Client)
c.HeadAmp = newHeadAmp(&c.Client)
c.Snapshot = newSnapshot(&c.Client)
c.DCA = newDCA(&c.Client)
c.Main = newMainStereo(&c.client)
c.MainMono = newMainMono(&c.client)
c.Matrix = newMatrix(&c.client)
c.Strip = newStrip(&c.client)
c.Bus = newBus(&c.client)
c.HeadAmp = newHeadAmp(&c.client)
c.Snapshot = newSnapshot(&c.client)
c.DCA = newDCA(&c.client)
return c, nil
}
// NewXAirClient creates a new XAirClient instance with optional engine configuration
func NewXAirClient(mixerIP string, mixerPort int, opts ...EngineOption) (*XAirClient, error) {
e, err := newEngine(mixerIP, mixerPort, kindXAir, opts...)
if err != nil {
return nil, err
}
c := &XAirClient{
Client: Client{e},
}
c.Main = newMainStereo(&c.Client)
c.Strip = newStrip(&c.Client)
c.Bus = newBus(&c.Client)
c.HeadAmp = newHeadAmp(&c.Client)
c.Snapshot = newSnapshot(&c.Client)
c.DCA = newDCA(&c.Client)
return c, nil
type client struct {
*engine
Info InfoResponse
}
// Start begins listening for messages in a goroutine
func (c *Client) StartListening() {
func (c *client) StartListening() {
go c.engine.receiveLoop()
log.Debugf("Started listening on %s...", c.engine.conn.LocalAddr().String())
}
// Close stops the client and closes the connection
func (c *Client) Close() {
func (c *client) Close() {
close(c.engine.done)
if c.engine.conn != nil {
c.engine.conn.Close()
@@ -94,12 +95,12 @@ func (c *Client) Close() {
}
// SendMessage sends an OSC message to the mixer using the unified connection
func (c *Client) SendMessage(address string, args ...any) error {
func (c *client) SendMessage(address string, args ...any) error {
return c.engine.sendToAddress(c.mixerAddr, address, args...)
}
// ReceiveMessage receives an OSC message from the mixer
func (c *Client) ReceiveMessage() (*osc.Message, error) {
func (c *client) ReceiveMessage() (*osc.Message, error) {
t := time.Tick(c.engine.timeout)
select {
case <-t:
@@ -113,7 +114,7 @@ func (c *Client) ReceiveMessage() (*osc.Message, error) {
}
// RequestInfo requests mixer information
func (c *Client) RequestInfo() (InfoResponse, error) {
func (c *client) RequestInfo() (InfoResponse, error) {
var info InfoResponse
err := c.SendMessage("/xinfo")
if err != nil {
@@ -124,20 +125,31 @@ func (c *Client) RequestInfo() (InfoResponse, error) {
if err != nil {
return info, err
}
if len(msg.Arguments) >= 3 {
info.Host = msg.Arguments[0].(string)
info.Name = msg.Arguments[1].(string)
info.Model = msg.Arguments[2].(string)
if len(msg.Arguments) == 4 {
if host, ok := msg.Arguments[0].(string); ok {
info.Host = host
}
if name, ok := msg.Arguments[1].(string); ok {
info.Name = name
}
if model, ok := msg.Arguments[2].(string); ok {
info.Model = model
}
if firmware, ok := msg.Arguments[3].(string); ok {
info.Firmware = firmware
}
}
c.Info = info
return info, nil
}
// KeepAlive sends keep-alive message (required for multi-client usage)
func (c *Client) KeepAlive() error {
func (c *client) KeepAlive() error {
return c.SendMessage("/xremote")
}
// RequestStatus requests mixer status
func (c *Client) RequestStatus() error {
func (c *client) RequestStatus() error {
return c.SendMessage("/status")
}

View File

@@ -4,13 +4,13 @@ import "fmt"
// Comp represents the compressor parameters.
type Comp struct {
client *Client
client *client
baseAddress string
AddressFunc func(fmtString string, args ...any) string
}
// Factory function to create Comp instance with optional configuration
func newComp(c *Client, baseAddress string, opts ...CompOption) *Comp {
func newComp(c *client, baseAddress string, opts ...CompOption) *Comp {
comp := &Comp{
client: c,
baseAddress: fmt.Sprintf("%s/dyn", baseAddress),

View File

@@ -3,12 +3,12 @@ package xair
import "fmt"
type DCA struct {
client *Client
client *client
baseAddress string
}
// newDCA creates a new DCA instance
func newDCA(c *Client) *DCA {
func newDCA(c *client) *DCA {
return &DCA{
client: c,
baseAddress: c.addressMap["dca"],

View File

@@ -6,13 +6,13 @@ import (
// Eq represents the EQ parameters.
type Eq struct {
client *Client
client *client
baseAddress string
AddressFunc func(fmtString string, args ...any) string
}
// Factory function to create Eq instance with optional configuration
func newEq(c *Client, baseAddress string, opts ...EqOption) *Eq {
func newEq(c *client, baseAddress string, opts ...EqOption) *Eq {
eq := &Eq{
client: c,
baseAddress: fmt.Sprintf("%s/eq", baseAddress),

View File

@@ -4,13 +4,13 @@ import "fmt"
// Gate represents the gate parameters.
type Gate struct {
client *Client
client *client
baseAddress string
AddressFunc func(fmtString string, args ...any) string
}
// Factory function to create Gate instance with optional configuration
func newGate(c *Client, baseAddress string, opts ...GateOption) *Gate {
func newGate(c *client, baseAddress string, opts ...GateOption) *Gate {
gate := &Gate{
client: c,
baseAddress: fmt.Sprintf("%s/gate", baseAddress),

View File

@@ -3,12 +3,12 @@ package xair
import "fmt"
type HeadAmp struct {
client *Client
client *client
baseAddress string
}
// newHeadAmp creates a new HeadAmp instance with the provided client.
func newHeadAmp(c *Client) *HeadAmp {
func newHeadAmp(c *client) *HeadAmp {
return &HeadAmp{
client: c,
baseAddress: c.addressMap["headamp"],

View File

@@ -3,14 +3,14 @@ package xair
import "fmt"
type Main struct {
client *Client
client *client
baseAddress string
Eq *Eq
Comp *Comp
}
// newMainStereo creates a new Main instance for stereo main output
func newMainStereo(c *Client) *Main {
func newMainStereo(c *client) *Main {
addressFunc := func(fmtString string, args ...any) string {
return fmtString
}
@@ -24,7 +24,7 @@ func newMainStereo(c *Client) *Main {
}
// newMainMono creates a new MainMono instance for mono main output (X32 only)
func newMainMono(c *Client) *Main {
func newMainMono(c *client) *Main {
addressFunc := func(fmtString string, args ...any) string {
return fmtString
}

View File

@@ -3,14 +3,14 @@ package xair
import "fmt"
type Matrix struct {
client *Client
client *client
baseAddress string
Eq *Eq
Comp *Comp
}
// newMatrix creates a new Matrix instance
func newMatrix(c *Client) *Matrix {
func newMatrix(c *client) *Matrix {
return &Matrix{
client: c,
baseAddress: c.addressMap["matrix"],

View File

@@ -4,4 +4,5 @@ type InfoResponse struct {
Host string
Name string
Model string
Firmware string
}

View File

@@ -3,12 +3,12 @@ package xair
import "fmt"
type Snapshot struct {
client *Client
client *client
baseAddress string
}
// newSnapshot creates a new Snapshot instance
func newSnapshot(c *Client) *Snapshot {
func newSnapshot(c *client) *Snapshot {
return &Snapshot{
client: c,
baseAddress: c.addressMap["snapshot"],

View File

@@ -3,7 +3,7 @@ package xair
import "fmt"
type Strip struct {
client *Client
client *client
baseAddress string
Gate *Gate
Eq *Eq
@@ -11,7 +11,7 @@ type Strip struct {
}
// newStrip creates a new Strip instance
func newStrip(c *Client) *Strip {
func newStrip(c *client) *Strip {
return &Strip{
client: c,
baseAddress: c.addressMap["strip"],
@@ -126,7 +126,7 @@ func (s *Strip) SetColor(strip int, color int32) error {
return s.client.SendMessage(address, color)
}
// SendLevel requests the sends level for a mixbus.
// SendLevel requests auxiliary send level for a send destination.
func (s *Strip) SendLevel(strip int, bus int) (float64, error) {
address := fmt.Sprintf(s.baseAddress, strip) + fmt.Sprintf("/mix/%02d/level", bus)
err := s.client.SendMessage(address)
@@ -145,7 +145,7 @@ func (s *Strip) SendLevel(strip int, bus int) (float64, error) {
return mustDbFrom(float64(val)), nil
}
// SetSendLevel sets the sends level for a mixbus.
// SetSendLevel sets the auxiliary send level for a send destination.
func (s *Strip) SetSendLevel(strip int, bus int, level float64) error {
address := fmt.Sprintf(s.baseAddress, strip) + fmt.Sprintf("/mix/%02d/level", bus)
return s.client.SendMessage(address, float32(mustDbInto(level)))

View File

@@ -12,9 +12,8 @@ Flags:
-v, --version Print x32-cli version information and quit
Commands:
completion (c) Generate shell completion scripts.
Raw
completion Generate shell completion scripts.
info Print mixer information.
raw Send raw OSC messages to the mixer.
Main

View File

@@ -12,9 +12,8 @@ Flags:
-v, --version Print xair-cli version information and quit
Commands:
completion (c) Generate shell completion scripts.
Raw
completion Generate shell completion scripts.
info Print mixer information.
raw Send raw OSC messages to the mixer.
Main