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 Device struct {
	// DeviceName: name of the device.
	DeviceName DeviceName `json:"DeviceName"`
	// DeviceIndex: index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// DeviceMessages: a list of the messages a device will accept on this
	// server implementation.
	DeviceMessages         DeviceMessages       `json:"DeviceMessages"`
	DeviceDisplayName      ptr.Optional[string] `json:"DeviceDisplayName,omitzero"`
	DeviceMessageTimingGap ptr.Optional[int]    `json:"DeviceMessageTimingGap,omitzero"`
}

type DeviceAddedMessage 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"`
	// DeviceName: name of the device.
	DeviceName DeviceName `json:"DeviceName"`
	// DeviceIndex: index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// DeviceMessages: a list of the messages a device will accept on this
	// server implementation.
	DeviceMessages         DeviceMessages       `json:"DeviceMessages"`
	DeviceDisplayName      ptr.Optional[string] `json:"DeviceDisplayName,omitzero"`
	DeviceMessageTimingGap ptr.Optional[int]    `json:"DeviceMessageTimingGap,omitzero"`
}

type DeviceIndex int

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

type DeviceMessages struct {
	LinearCmd []LinearCmdInfo `json:"LinearCmd,omitzero"`
	// RawReadCmd: attributes for raw device messages.
	RawReadCmd ptr.Optional[RawMessageAttributes] `json:"RawReadCmd,omitzero"`
	// RawSubscribeCmd: attributes for raw device messages.
	RawSubscribeCmd ptr.Optional[RawMessageAttributes] `json:"RawSubscribeCmd,omitzero"`
	// RawWriteCmd: attributes for raw device messages.
	RawWriteCmd        ptr.Optional[RawMessageAttributes] `json:"RawWriteCmd,omitzero"`
	RotateCmd          []RotateCmdInfo                    `json:"RotateCmd,omitzero"`
	ScalarCmd          []ScalarCmdInfo                    `json:"ScalarCmd,omitzero"`
	SensorReadCmd      []SensorReadCmdItem                `json:"SensorReadCmd,omitzero"`
	SensorSubscribeCmd []SensorSubscribeCmdItem           `json:"SensorSubscribeCmd,omitzero"`
	// StopDeviceCmd: attributes for device message that have no attributes.
	StopDeviceCmd ptr.Optional[NullMessageAttributes] `json:"StopDeviceCmd,omitzero"`
}

type DeviceName string

type DeviceRemovedMessage 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"`
	// DeviceIndex: index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
}

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 InternalMessage struct{}

type LinearCmdInfo struct {
	// ActuatorType: denotes type of actuator (Vibrator, Linear, Oscillator,
	// etc...).
	ActuatorType      ptr.Optional[string] `json:"ActuatorType,omitzero"`
	FeatureDescriptor ptr.Optional[string] `json:"FeatureDescriptor,omitzero"`
	// StepCount: specifies granularity of each feature on the device.
	StepCount ptr.Optional[StepCount] `json:"StepCount,omitzero"`
}

type LinearCmdMessage 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"`
	// Vectors: device linear movement times (milliseconds) and positions
	// (floating point, 0 < x < 1) keyed on linear actuator number, stepping
	// will be device specific.
	Vectors []Vector `json:"Vectors"`
}

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

type MessageType string

type NullMessageAttributes struct{}

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

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 RawMessageAttributes struct {
	Endpoints []string `json:"Endpoints,omitzero"`
}

type RawReadCmdMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ClientID `json:"Id"`
	// Endpoint (from device config file) from which the data was retrieved.
	Endpoint string `json:"Endpoint"`
	// DeviceIndex: index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Length: amount of data to read from device, 0 to exhaust whatever is in
	// immediate buffer.
	Length int `json:"Length"`
	// WaitForData: if true, then wait until Length amount of data is available.
	WaitForData bool `json:"WaitForData"`
}

type RawReadingMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ServerID `json:"Id"`
	// Endpoint (from device config file) from which the data was retrieved.
	Endpoint string `json:"Endpoint"`
	// DeviceIndex: index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Data: raw byte string received from device.
	Data []int `json:"Data"`
}

type RawSubscribeCmdMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ClientID `json:"Id"`
	// Endpoint (from device config file) from which the data was retrieved.
	Endpoint string `json:"Endpoint"`
	// DeviceIndex: index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
}

type RawUnsubscribeCmdMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ClientID `json:"Id"`
	// Endpoint (from device config file) from which the data was retrieved.
	Endpoint string `json:"Endpoint"`
	// DeviceIndex: index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
}

type RawWriteCmdMessage struct {
	// ID: user-set id for the message. 0 denotes system message and is
	// reserved.
	ID ClientID `json:"Id"`
	// Endpoint (from device config file) to send command to.
	Endpoint string `json:"Endpoint"`
	// DeviceIndex: index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Data: raw byte string to send to device.
	Data []int `json:"Data"`
	// WriteWithResponse: if true, BLE writes will use WriteWithResponse.
	// Value ignored for all other types.
	WriteWithResponse bool `json:"WriteWithResponse"`
}

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"`
	// MessageVersion: message template version of the client software.
	MessageVersion int `json:"MessageVersion"`
}

type RotateCmdInfo struct {
	// ActuatorType: denotes type of actuator (Vibrator, Linear, Oscillator,
	// etc...).
	ActuatorType      ptr.Optional[string] `json:"ActuatorType,omitzero"`
	FeatureDescriptor ptr.Optional[string] `json:"FeatureDescriptor,omitzero"`
	// StepCount: specifies granularity of each feature on the device.
	StepCount ptr.Optional[StepCount] `json:"StepCount,omitzero"`
}

type RotateCmdMessage 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"`
	// Rotations: device rotation speeds (floating point, 0 < x < 1) keyed on
	// rotator number, stepping will be device specific.
	Rotations []Rotation `json:"Rotations"`
}

type Rotation struct {
	// Index: rotator number.
	Index int `json:"Index"`
	// Speed: rotation speed (floating point, 0 < x < 1), stepping will be
	// device specific.
	Speed float64 `json:"Speed"`
	// Clockwise: rotation direction (boolean). Not all devices have a concept
	// of actual clockwise.
	Clockwise bool `json:"Clockwise"`
}

type Scalar struct {
	// Index: actuator index.
	Index int `json:"Index"`
	// Scalar: actuator scalar (floating point, range can vary), stepping will
	// be device specific.
	Scalar float64 `json:"Scalar"`
	// ActuatorType: actuator type that is expected to be controlled with this
	// subcommand.
	ActuatorType string `json:"ActuatorType"`
}

type ScalarCmdInfo struct {
	// ActuatorType: denotes type of actuator (Vibrator, Linear, Oscillator,
	// etc...).
	ActuatorType      ptr.Optional[string] `json:"ActuatorType,omitzero"`
	FeatureDescriptor ptr.Optional[string] `json:"FeatureDescriptor,omitzero"`
	// StepCount: specifies granularity of each feature on the device.
	StepCount ptr.Optional[StepCount] `json:"StepCount,omitzero"`
}

type ScalarCmdMessage 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"`
	// Scalars: device actution scalar (floating point, range can vary) keyed on
	// acutator index, stepping will be device specific.
	Scalars []Scalar `json:"Scalars"`
}

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 SensorReadCmdItem struct {
	SensorType        string   `json:"SensorType"`
	FeatureDescriptor string   `json:"FeatureDescriptor"`
	SensorRange       [][2]int `json:"SensorRange"`
}

type SensorReadCmdMessage 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"`
	SensorIndex int         `json:"SensorIndex"`
	SensorType  string      `json:"SensorType"`
}

type SensorReadingMessage 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"`
	SensorIndex int         `json:"SensorIndex"`
	SensorType  string      `json:"SensorType"`
	Data        []int       `json:"Data"`
}

type SensorSubscribeCmdItem struct {
	SensorType        string   `json:"SensorType"`
	FeatureDescriptor string   `json:"FeatureDescriptor"`
	SensorRange       [][2]int `json:"SensorRange"`
}

type SensorSubscribeCmdMessage 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"`
	SensorIndex int         `json:"SensorIndex"`
	SensorType  string      `json:"SensorType"`
}

type SensorUnsubscribeCmdMessage 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"`
	SensorIndex int         `json:"SensorIndex"`
	SensorType  string      `json:"SensorType"`
}

type ServerID int

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

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 StepCount int

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

type Vector struct {
	// Index: linear actuator number.
	Index int `json:"Index"`
	// Duration: linear movement time in milliseconds.
	Duration float64 `json:"Duration"`
	// Position: linear movement position (floating point, 0 < x < 1), stepping
	// will be device specific.
	Position float64 `json:"Position"`
}