schema

type ClientID int

type ClientMessage interface {
	Message
	// ClientID returns the ID field of the message.
	ClientID() ClientID
	// WithID sets the ID field of the shallow-copied message and returns the modified message.
	WithID(id ClientID) ClientMessage
	// contains filtered or unexported methods
}

type DeviceFeature struct {
	FeatureDescription string                            `json:"FeatureDescription"`
	FeatureIndex       int                               `json:"FeatureIndex"`
	Input              ptr.Optional[DeviceFeatureInput]  `json:"Input,omitzero"`
	Output             ptr.Optional[DeviceFeatureOutput] `json:"Output,omitzero"`
}

type DeviceFeatureInput map[string]DeviceFeatureInputValue

type DeviceFeatureInputValue struct {
	ValueRange [][]int `json:"ValueRange"`
}

type DeviceFeatureOutput map[DeviceFeatureOutputKey]DeviceFeatureOutputValueType

type DeviceFeatureOutputKey string

type DeviceFeatureOutputPositionWithDurationValue struct {
	// Position: serialization of Rust's RangeInclusive Type.
	Position RangeInclusive `json:"Position"`
	// Duration: serialization of Rust's RangeInclusive Type.
	Duration RangeInclusive `json:"Duration"`
}

type DeviceFeatureOutputValue struct {
	// Value: serialization of Rust's RangeInclusive Type.
	Value RangeInclusive `json:"Value"`
}

type DeviceFeatureOutputValueType interface {
	// contains filtered or unexported methods
}

type DeviceIndex int

type DeviceListDevices map[int]DeviceListDevicesValue

type DeviceListDevicesValue struct {
	// DeviceName: name of the device.
	DeviceName DeviceName `json:"DeviceName"`
	// DeviceIndex: index used for referencing the device in device messages.
	DeviceIndex            DeviceIndex                          `json:"DeviceIndex"`
	DeviceMessageTimingGap int                                  `json:"DeviceMessageTimingGap"`
	DeviceFeatures         DeviceListDevicesValueDeviceFeatures `json:"DeviceFeatures"`
	DeviceDisplayName      ptr.Optional[string]                 `json:"DeviceDisplayName,omitzero"`
}

type DeviceListDevicesValueDeviceFeatures map[int]DeviceFeature

type DeviceListMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ServerID `json:"Id"`
	// Devices: array of device ids and names.
	Devices DeviceListDevices `json:"Devices"`
}

type DeviceName string

type ErrorMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID           ServerID `json:"Id"`
	ErrorMessage string   `json:"ErrorMessage"`
	ErrorCode    float64  `json:"ErrorCode"`
}

type InputCmdMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ClientID `json:"Id"`
	// DeviceIndex: index used for referencing the device in device messages.
	DeviceIndex  DeviceIndex `json:"DeviceIndex"`
	FeatureIndex int         `json:"FeatureIndex"`
	InputType    string      `json:"InputType"`
	InputCommand string      `json:"InputCommand"`
}

type InputReadingData map[InputReadingDataKey]int

type InputReadingDataKey string

type InputReadingMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ServerID `json:"Id"`
	// DeviceIndex: index used for referencing the device in device messages.
	DeviceIndex  DeviceIndex      `json:"DeviceIndex"`
	FeatureIndex int              `json:"FeatureIndex"`
	Data         InputReadingData `json:"Data"`
}

type InternalMessage struct{}

type Message interface {
	// Type returns the message type of the message.
	Type() MessageType
	// contains filtered or unexported methods
}

type MessageType string

type OKMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ClientID `json:"Id"`
}

type OutputCmd map[OutputCmdKey]OutputCmdValueType

type OutputCmdKey string

type OutputCmdMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ClientID `json:"Id"`
	// DeviceIndex: index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// FeatureIndex: index used for referencing the device in device messages.
	FeatureIndex DeviceIndex `json:"FeatureIndex"`
	Command      OutputCmd   `json:"Command"`
}

type OutputCmdPositionWithDurationValue struct {
	Position float64 `json:"Position"`
	Duration float64 `json:"Duration"`
}

type OutputCmdValue struct {
	Value float64 `json:"Value"`
}

type OutputCmdValueType interface {
	// contains filtered or unexported methods
}

type Payload []Message

type PingMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ClientID `json:"Id"`
}

type RangeInclusive [2]int

type RequestDeviceListMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ClientID `json:"Id"`
}

type RequestServerInfoMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ClientID `json:"Id"`
	// ClientName: name of the client software.
	ClientName string `json:"ClientName"`
	// ProtocolVersionMajor: message template version of the server software.
	ProtocolVersionMajor int `json:"ProtocolVersionMajor"`
	// ProtocolVersionMinor: message template version of the server software.
	ProtocolVersionMinor int `json:"ProtocolVersionMinor"`
}

type ScanningFinishedMessage struct {
	// ID: used for non-direct-reply messages that can only be sent from server
	// to client, using the reserved system message Id of 0.
	ID SystemID `json:"Id"`
}

type ServerID int

type ServerInfoMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ptr.Optional[ClientID] `json:"Id,omitzero"`
	// MaxPingTime: maximum time (in milliseconds) the server will wait between
	// ping messages from client before shutting down.
	MaxPingTime ptr.Optional[int] `json:"MaxPingTime,omitzero"`
	// ProtocolVersionMajor: message template version of the server software.
	ProtocolVersionMajor ptr.Optional[int] `json:"ProtocolVersionMajor,omitzero"`
	// ProtocolVersionMinor: message template version of the server software.
	ProtocolVersionMinor ptr.Optional[int] `json:"ProtocolVersionMinor,omitzero"`
	// ServerName: name of the server. Can be 0-length.
	ServerName ptr.Optional[string] `json:"ServerName,omitzero"`
}

type ServerMessage interface {
	Message
	// ServerID returns the ID field of the message.
	ServerID() ServerID
	// contains filtered or unexported methods
}

type StartScanningMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ClientID `json:"Id"`
}

type StopAllDevicesMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ClientID `json:"Id"`
}

type StopDeviceCmdMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ClientID `json:"Id"`
	// DeviceIndex: index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
}

type StopScanningMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ClientID `json:"Id"`
}

type SystemID int