buttplug-generated.go

// Code generated by ./internal/cmd/genschema. DO NOT EDIT.

package buttplug

import "encoding/json"

// MessageType identifies a message type in a Messages object. It is also the
// object key in the Messages object.
type MessageType string

const (
	OKMessage                      MessageType = "Ok"
	ErrorMessage                   MessageType = "Error"
	PingMessage                    MessageType = "Ping"
	TestMessage                    MessageType = "Test"
	DeviceListMessage              MessageType = "DeviceList"
	DeviceAddedMessage             MessageType = "DeviceAdded"
	DeviceRemovedMessage           MessageType = "DeviceRemoved"
	RequestDeviceListMessage       MessageType = "RequestDeviceList"
	StopDeviceCmdMessage           MessageType = "StopDeviceCmd"
	StopAllDevicesMessage          MessageType = "StopAllDevices"
	StartScanningMessage           MessageType = "StartScanning"
	StopScanningMessage            MessageType = "StopScanning"
	ScanningFinishedMessage        MessageType = "ScanningFinished"
	RequestLogMessage              MessageType = "RequestLog"
	LogMessage                     MessageType = "Log"
	RequestServerInfoMessage       MessageType = "RequestServerInfo"
	ServerInfoMessage              MessageType = "ServerInfo"
	FleshlightLaunchFW12CmdMessage MessageType = "FleshlightLaunchFW12Cmd"
	LovenseCmdMessage              MessageType = "LovenseCmd"
	SingleMotorVibrateCmdMessage   MessageType = "SingleMotorVibrateCmd"
	KiirooCmdMessage               MessageType = "KiirooCmd"
	RawReadCmdMessage              MessageType = "RawReadCmd"
	RawWriteCmdMessage             MessageType = "RawWriteCmd"
	RawSubscribeCmdMessage         MessageType = "RawSubscribeCmd"
	RawUnsubscribeCmdMessage       MessageType = "RawUnsubscribeCmd"
	RawReadingMessage              MessageType = "RawReading"
	VorzeA10CycloneCmdMessage      MessageType = "VorzeA10CycloneCmd"
	VibrateCmdMessage              MessageType = "VibrateCmd"
	RotateCmdMessage               MessageType = "RotateCmd"
	LinearCmdMessage               MessageType = "LinearCmd"
	BatteryLevelCmdMessage         MessageType = "BatteryLevelCmd"
	BatteryLevelReadingMessage     MessageType = "BatteryLevelReading"
	RSSILevelCmdMessage            MessageType = "RSSILevelCmd"
	RSSILevelReadingMessage        MessageType = "RSSILevelReading"
)

// Message is an interface ethat all messages will satisfy. All types that are
// inside MessageType will implement the interface. Inside this type declaration
// lists all types that will satisfy the interface.
type Message interface {
	// These types satisfy this interface:
	//    - OK
	//    - Error
	//    - Ping
	//    - Test
	//    - DeviceList
	//    - DeviceAdded
	//    - DeviceRemoved
	//    - RequestDeviceList
	//    - StopDeviceCmd
	//    - StopAllDevices
	//    - StartScanning
	//    - StopScanning
	//    - ScanningFinished
	//    - RequestLog
	//    - Log
	//    - RequestServerInfo
	//    - ServerInfo
	//    - FleshlightLaunchFW12Cmd
	//    - LovenseCmd
	//    - SingleMotorVibrateCmd
	//    - KiirooCmd
	//    - RawReadCmd
	//    - RawWriteCmd
	//    - RawSubscribeCmd
	//    - RawUnsubscribeCmd
	//    - RawReading
	//    - VorzeA10CycloneCmd
	//    - VibrateCmd
	//    - RotateCmd
	//    - LinearCmd
	//    - BatteryLevelCmd
	//    - BatteryLevelReading
	//    - RSSILevelCmd
	//    - RSSILevelReading

	// MessageID returns the message's ID, or 0 if the message is a system
	// message.
	MessageID() ID
	// SetMessageID sets the message ID field. This is used for sending.
	SetMessageID(ID)
	// MessageType returns the message's type (object key).
	MessageType() MessageType
}

// Messages is the large messages object that's passed around.
type Messages map[MessageType]Message

// MessageID implements Message.
func (o *OK) MessageID() ID { return ID(o.ID) }

// SetMessageID implements Message.
func (o *OK) SetMessageID(id ID) {
	o.ID = ID(id)
}

// MessageType implements Message.
func (o *OK) MessageType() MessageType { return OKMessage }

// MessageID implements Message.
func (e *Error) MessageID() ID { return ID(e.ID) }

// SetMessageID implements Message.
func (e *Error) SetMessageID(id ID) {
	e.ID = ID(id)
}

// MessageType implements Message.
func (e *Error) MessageType() MessageType { return ErrorMessage }

// MessageID implements Message.
func (p *Ping) MessageID() ID { return ID(p.ID) }

// SetMessageID implements Message.
func (p *Ping) SetMessageID(id ID) {
	p.ID = ID(id)
}

// MessageType implements Message.
func (p *Ping) MessageType() MessageType { return PingMessage }

// MessageID implements Message.
func (t *Test) MessageID() ID { return ID(t.ID) }

// SetMessageID implements Message.
func (t *Test) SetMessageID(id ID) {
	t.ID = ID(id)
}

// MessageType implements Message.
func (t *Test) MessageType() MessageType { return TestMessage }

// MessageID implements Message.
func (d *DeviceList) MessageID() ID { return ID(d.ID) }

// SetMessageID implements Message.
func (d *DeviceList) SetMessageID(id ID) {
	d.ID = ID(id)
}

// MessageType implements Message.
func (d *DeviceList) MessageType() MessageType { return DeviceListMessage }

// MessageID implements Message.
func (d *DeviceAdded) MessageID() ID { return ID(d.ID) }

// SetMessageID implements Message.
func (d *DeviceAdded) SetMessageID(id ID) {
	d.ID = SystemID(id)
}

// MessageType implements Message.
func (d *DeviceAdded) MessageType() MessageType { return DeviceAddedMessage }

// MessageID implements Message.
func (d *DeviceRemoved) MessageID() ID { return ID(d.ID) }

// SetMessageID implements Message.
func (d *DeviceRemoved) SetMessageID(id ID) {
	d.ID = ID(id)
}

// MessageType implements Message.
func (d *DeviceRemoved) MessageType() MessageType { return DeviceRemovedMessage }

// MessageID implements Message.
func (r *RequestDeviceList) MessageID() ID { return ID(r.ID) }

// SetMessageID implements Message.
func (r *RequestDeviceList) SetMessageID(id ID) {
	r.ID = ID(id)
}

// MessageType implements Message.
func (r *RequestDeviceList) MessageType() MessageType { return RequestDeviceListMessage }

// MessageID implements Message.
func (s *StopDeviceCmd) MessageID() ID { return ID(s.ID) }

// SetMessageID implements Message.
func (s *StopDeviceCmd) SetMessageID(id ID) {
	s.ID = ID(id)
}

// MessageType implements Message.
func (s *StopDeviceCmd) MessageType() MessageType { return StopDeviceCmdMessage }

// MessageID implements Message.
func (s *StopAllDevices) MessageID() ID { return ID(s.ID) }

// SetMessageID implements Message.
func (s *StopAllDevices) SetMessageID(id ID) {
	s.ID = ID(id)
}

// MessageType implements Message.
func (s *StopAllDevices) MessageType() MessageType { return StopAllDevicesMessage }

// MessageID implements Message.
func (s *StartScanning) MessageID() ID { return ID(s.ID) }

// SetMessageID implements Message.
func (s *StartScanning) SetMessageID(id ID) {
	s.ID = ID(id)
}

// MessageType implements Message.
func (s *StartScanning) MessageType() MessageType { return StartScanningMessage }

// MessageID implements Message.
func (s *StopScanning) MessageID() ID { return ID(s.ID) }

// SetMessageID implements Message.
func (s *StopScanning) SetMessageID(id ID) {
	s.ID = ID(id)
}

// MessageType implements Message.
func (s *StopScanning) MessageType() MessageType { return StopScanningMessage }

// MessageID implements Message.
func (s *ScanningFinished) MessageID() ID { return ID(s.ID) }

// SetMessageID implements Message.
func (s *ScanningFinished) SetMessageID(id ID) {
	s.ID = SystemID(id)
}

// MessageType implements Message.
func (s *ScanningFinished) MessageType() MessageType { return ScanningFinishedMessage }

// MessageID implements Message.
func (r *RequestLog) MessageID() ID { return ID(r.ID) }

// SetMessageID implements Message.
func (r *RequestLog) SetMessageID(id ID) {
	r.ID = ID(id)
}

// MessageType implements Message.
func (r *RequestLog) MessageType() MessageType { return RequestLogMessage }

// MessageID implements Message.
func (l *Log) MessageID() ID { return ID(l.ID) }

// SetMessageID implements Message.
func (l *Log) SetMessageID(id ID) {
	l.ID = SystemID(id)
}

// MessageType implements Message.
func (l *Log) MessageType() MessageType { return LogMessage }

// MessageID implements Message.
func (r *RequestServerInfo) MessageID() ID { return ID(r.ID) }

// SetMessageID implements Message.
func (r *RequestServerInfo) SetMessageID(id ID) {
	r.ID = ID(id)
}

// MessageType implements Message.
func (r *RequestServerInfo) MessageType() MessageType { return RequestServerInfoMessage }

// MessageID implements Message.
func (s *ServerInfo) MessageID() ID { return ID(s.ID) }

// SetMessageID implements Message.
func (s *ServerInfo) SetMessageID(id ID) {
	s.ID = ID(id)
}

// MessageType implements Message.
func (s *ServerInfo) MessageType() MessageType { return ServerInfoMessage }

// MessageID implements Message.
func (f *FleshlightLaunchFW12Cmd) MessageID() ID { return ID(f.ID) }

// SetMessageID implements Message.
func (f *FleshlightLaunchFW12Cmd) SetMessageID(id ID) {
	f.ID = ID(id)
}

// MessageType implements Message.
func (f *FleshlightLaunchFW12Cmd) MessageType() MessageType { return FleshlightLaunchFW12CmdMessage }

// MessageID implements Message.
func (l *LovenseCmd) MessageID() ID { return ID(l.ID) }

// SetMessageID implements Message.
func (l *LovenseCmd) SetMessageID(id ID) {
	l.ID = ID(id)
}

// MessageType implements Message.
func (l *LovenseCmd) MessageType() MessageType { return LovenseCmdMessage }

// MessageID implements Message.
func (s *SingleMotorVibrateCmd) MessageID() ID { return ID(s.ID) }

// SetMessageID implements Message.
func (s *SingleMotorVibrateCmd) SetMessageID(id ID) {
	s.ID = ID(id)
}

// MessageType implements Message.
func (s *SingleMotorVibrateCmd) MessageType() MessageType { return SingleMotorVibrateCmdMessage }

// MessageID implements Message.
func (k *KiirooCmd) MessageID() ID { return ID(k.ID) }

// SetMessageID implements Message.
func (k *KiirooCmd) SetMessageID(id ID) {
	k.ID = ID(id)
}

// MessageType implements Message.
func (k *KiirooCmd) MessageType() MessageType { return KiirooCmdMessage }

// MessageID implements Message.
func (r *RawReadCmd) MessageID() ID { return ID(r.ID) }

// SetMessageID implements Message.
func (r *RawReadCmd) SetMessageID(id ID) {
	r.ID = ID(id)
}

// MessageType implements Message.
func (r *RawReadCmd) MessageType() MessageType { return RawReadCmdMessage }

// MessageID implements Message.
func (r *RawWriteCmd) MessageID() ID { return ID(r.ID) }

// SetMessageID implements Message.
func (r *RawWriteCmd) SetMessageID(id ID) {
	r.ID = ID(id)
}

// MessageType implements Message.
func (r *RawWriteCmd) MessageType() MessageType { return RawWriteCmdMessage }

// MessageID implements Message.
func (r *RawSubscribeCmd) MessageID() ID { return ID(r.ID) }

// SetMessageID implements Message.
func (r *RawSubscribeCmd) SetMessageID(id ID) {
	r.ID = ID(id)
}

// MessageType implements Message.
func (r *RawSubscribeCmd) MessageType() MessageType { return RawSubscribeCmdMessage }

// MessageID implements Message.
func (r *RawUnsubscribeCmd) MessageID() ID { return ID(r.ID) }

// SetMessageID implements Message.
func (r *RawUnsubscribeCmd) SetMessageID(id ID) {
	r.ID = ID(id)
}

// MessageType implements Message.
func (r *RawUnsubscribeCmd) MessageType() MessageType { return RawUnsubscribeCmdMessage }

// MessageID implements Message.
func (r *RawReading) MessageID() ID { return ID(r.ID) }

// SetMessageID implements Message.
func (r *RawReading) SetMessageID(id ID) {
	r.ID = ID(id)
}

// MessageType implements Message.
func (r *RawReading) MessageType() MessageType { return RawReadingMessage }

// MessageID implements Message.
func (v *VorzeA10CycloneCmd) MessageID() ID { return ID(v.ID) }

// SetMessageID implements Message.
func (v *VorzeA10CycloneCmd) SetMessageID(id ID) {
	v.ID = ID(id)
}

// MessageType implements Message.
func (v *VorzeA10CycloneCmd) MessageType() MessageType { return VorzeA10CycloneCmdMessage }

// MessageID implements Message.
func (v *VibrateCmd) MessageID() ID { return ID(v.ID) }

// SetMessageID implements Message.
func (v *VibrateCmd) SetMessageID(id ID) {
	v.ID = ID(id)
}

// MessageType implements Message.
func (v *VibrateCmd) MessageType() MessageType { return VibrateCmdMessage }

// MessageID implements Message.
func (r *RotateCmd) MessageID() ID { return ID(r.ID) }

// SetMessageID implements Message.
func (r *RotateCmd) SetMessageID(id ID) {
	r.ID = ID(id)
}

// MessageType implements Message.
func (r *RotateCmd) MessageType() MessageType { return RotateCmdMessage }

// MessageID implements Message.
func (l *LinearCmd) MessageID() ID { return ID(l.ID) }

// SetMessageID implements Message.
func (l *LinearCmd) SetMessageID(id ID) {
	l.ID = ID(id)
}

// MessageType implements Message.
func (l *LinearCmd) MessageType() MessageType { return LinearCmdMessage }

// MessageID implements Message.
func (b *BatteryLevelCmd) MessageID() ID { return ID(b.ID) }

// SetMessageID implements Message.
func (b *BatteryLevelCmd) SetMessageID(id ID) {
	b.ID = ID(id)
}

// MessageType implements Message.
func (b *BatteryLevelCmd) MessageType() MessageType { return BatteryLevelCmdMessage }

// MessageID implements Message.
func (b *BatteryLevelReading) MessageID() ID { return ID(b.ID) }

// SetMessageID implements Message.
func (b *BatteryLevelReading) SetMessageID(id ID) {
	b.ID = ID(id)
}

// MessageType implements Message.
func (b *BatteryLevelReading) MessageType() MessageType { return BatteryLevelReadingMessage }

// MessageID implements Message.
func (r *RSSILevelCmd) MessageID() ID { return ID(r.ID) }

// SetMessageID implements Message.
func (r *RSSILevelCmd) SetMessageID(id ID) {
	r.ID = ID(id)
}

// MessageType implements Message.
func (r *RSSILevelCmd) MessageType() MessageType { return RSSILevelCmdMessage }

// MessageID implements Message.
func (r *RSSILevelReading) MessageID() ID { return ID(r.ID) }

// SetMessageID implements Message.
func (r *RSSILevelReading) SetMessageID(id ID) {
	r.ID = ID(id)
}

// MessageType implements Message.
func (r *RSSILevelReading) MessageType() MessageType { return RSSILevelReadingMessage }

var knownMessages = map[MessageType]func() Message{
	OKMessage:                      func() Message { return &OK{} },
	ErrorMessage:                   func() Message { return &Error{} },
	PingMessage:                    func() Message { return &Ping{} },
	TestMessage:                    func() Message { return &Test{} },
	DeviceListMessage:              func() Message { return &DeviceList{} },
	DeviceAddedMessage:             func() Message { return &DeviceAdded{} },
	DeviceRemovedMessage:           func() Message { return &DeviceRemoved{} },
	RequestDeviceListMessage:       func() Message { return &RequestDeviceList{} },
	StopDeviceCmdMessage:           func() Message { return &StopDeviceCmd{} },
	StopAllDevicesMessage:          func() Message { return &StopAllDevices{} },
	StartScanningMessage:           func() Message { return &StartScanning{} },
	StopScanningMessage:            func() Message { return &StopScanning{} },
	ScanningFinishedMessage:        func() Message { return &ScanningFinished{} },
	RequestLogMessage:              func() Message { return &RequestLog{} },
	LogMessage:                     func() Message { return &Log{} },
	RequestServerInfoMessage:       func() Message { return &RequestServerInfo{} },
	ServerInfoMessage:              func() Message { return &ServerInfo{} },
	FleshlightLaunchFW12CmdMessage: func() Message { return &FleshlightLaunchFW12Cmd{} },
	LovenseCmdMessage:              func() Message { return &LovenseCmd{} },
	SingleMotorVibrateCmdMessage:   func() Message { return &SingleMotorVibrateCmd{} },
	KiirooCmdMessage:               func() Message { return &KiirooCmd{} },
	RawReadCmdMessage:              func() Message { return &RawReadCmd{} },
	RawWriteCmdMessage:             func() Message { return &RawWriteCmd{} },
	RawSubscribeCmdMessage:         func() Message { return &RawSubscribeCmd{} },
	RawUnsubscribeCmdMessage:       func() Message { return &RawUnsubscribeCmd{} },
	RawReadingMessage:              func() Message { return &RawReading{} },
	VorzeA10CycloneCmdMessage:      func() Message { return &VorzeA10CycloneCmd{} },
	VibrateCmdMessage:              func() Message { return &VibrateCmd{} },
	RotateCmdMessage:               func() Message { return &RotateCmd{} },
	LinearCmdMessage:               func() Message { return &LinearCmd{} },
	BatteryLevelCmdMessage:         func() Message { return &BatteryLevelCmd{} },
	BatteryLevelReadingMessage:     func() Message { return &BatteryLevelReading{} },
	RSSILevelCmdMessage:            func() Message { return &RSSILevelCmd{} },
	RSSILevelReadingMessage:        func() Message { return &RSSILevelReading{} },
}

// RegisterMessage registers a new message type. It call the constructor once to
// know the message type.
func RegisterMessage(new func() Message) {
	msg := new()
	knownMessages[msg.MessageType()] = new
}

// CreateMessages creates a Messages object from the given messages.
func CreateMessages(msgs ...Message) Messages {
	obj := make(Messages, len(msgs))
	for _, msg := range msgs {
		obj[msg.MessageType()] = msg
	}
	return obj
}

// User-set id for the message. 0 denotes system message and is reserved.
type ID int // [0, 4294967295]

// Message types that are expected to have an Id and nothing else.
type IDMessage struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
}

// Signifies successful processing of the message indicated by the id.
type OK struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
}

// Signifies the server encountered an error while processing the message
// indicated by the id.
type Error struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID           ID      `json:"Id"`
	ErrorMessage string  `json:"ErrorMessage"`
	ErrorCode    float64 `json:"ErrorCode"`
}

// Connection keep-alive message.
type Ping struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
}

// Used for connection/application testing. Causes server to echo back the
// string sent. Sending string of 'Error' will result in a server error.
type Test struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// String to be echo'd back from server. Setting this to 'Error' will cause
	// an error to be thrown.
	TestString string `json:"TestString"`
}

// Name of the device
type DeviceName string

// Index used for referencing the device in device messages.
type DeviceIndex int // [0, max]

// A list of the messages a device will accept on this server implementation.
type DeviceMessages []string

// Attributes for device message that have no attributes.
type NullMessageAttributes struct {
}

// Number of features on device.
type FeatureCount int // [1, max]

// Specifies granularity of each feature on the device.
type StepCount []int

// Attributes for device messages.
type GenericMessageAttributes struct {
	// Number of features on device.
	FeatureCount FeatureCount `json:"FeatureCount,omitempty"`
	// Specifies granularity of each feature on the device.
	StepCount []int `json:"StepCount,omitempty"`
}

// Attributes for raw device messages.
type RawMessageAttributes struct {
	Endpoints []string `json:"Endpoints,omitempty"`
}

// A list of the messages a device will accept on this server implementation.
type DeviceMessagesEx struct {
	// Attributes for device message that have no attributes.
	StopDeviceCmd NullMessageAttributes `json:"StopDeviceCmd,omitempty"`
	// Attributes for device messages.
	VibrateCmd GenericMessageAttributes `json:"VibrateCmd,omitempty"`
	// Attributes for device messages.
	LinearCmd GenericMessageAttributes `json:"LinearCmd,omitempty"`
	// Attributes for device messages.
	RotateCmd GenericMessageAttributes `json:"RotateCmd,omitempty"`
	// Attributes for device message that have no attributes.
	LovenseCmd NullMessageAttributes `json:"LovenseCmd,omitempty"`
	// Attributes for device message that have no attributes.
	VorzeA10CycloneCmd NullMessageAttributes `json:"VorzeA10CycloneCmd,omitempty"`
	// Attributes for device message that have no attributes.
	KiirooCmd NullMessageAttributes `json:"KiirooCmd,omitempty"`
	// Attributes for device message that have no attributes.
	SingleMotorVibrateCmd NullMessageAttributes `json:"SingleMotorVibrateCmd,omitempty"`
	// Attributes for device message that have no attributes.
	FleshlightLaunchFW12Cmd NullMessageAttributes `json:"FleshlightLaunchFW12Cmd,omitempty"`
	// Attributes for device message that have no attributes.
	BatteryLevelCmd NullMessageAttributes `json:"BatteryLevelCmd,omitempty"`
	// Attributes for device message that have no attributes.
	RSSILevelCmd NullMessageAttributes `json:"RSSILevelCmd,omitempty"`
	// Attributes for raw device messages.
	RawReadCmd RawMessageAttributes `json:"RawReadCmd,omitempty"`
	// Attributes for raw device messages.
	RawWriteCmd RawMessageAttributes `json:"RawWriteCmd,omitempty"`
	// Attributes for raw device messages.
	RawSubscribeCmd RawMessageAttributes `json:"RawSubscribeCmd,omitempty"`
	// Attributes for raw device messages.
	RawUnsubscribeCmd RawMessageAttributes `json:"RawUnsubscribeCmd,omitempty"`
}

// List of all available devices known to the system.
type DeviceList struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Array of device ids and names.
	Devices []struct {
		// Name of the device
		DeviceName DeviceName `json:"DeviceName"`
		// Index used for referencing the device in device messages.
		DeviceIndex    DeviceIndex `json:"DeviceIndex"`
		DeviceMessages json.RawMessage/* DeviceMessages, DeviceMessagesEx */ `json:"DeviceMessages"`
	} `json:"Devices"`
}

// Used for non-direct-reply messages that can only be sent from server to
// client, using the reserved system message Id of 0.
type SystemID int // [0, 0]

// Notifies client that a device of a certain type has been added to the server.
type DeviceAdded struct {
	// 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"`
	// Name of the device
	DeviceName DeviceName `json:"DeviceName"`
	// Index used for referencing the device in device messages.
	DeviceIndex    DeviceIndex `json:"DeviceIndex"`
	DeviceMessages json.RawMessage/* DeviceMessages, DeviceMessagesEx */ `json:"DeviceMessages"`
}

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

// Notifies client that a device of a certain type has been removed from the
// server.
type DeviceRemoved struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
}

// Request for the server to send a list of devices to the client.
type RequestDeviceList struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
}

// Stops the all actions currently being taken by a device.
type StopDeviceCmd struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
}

// Stops all actions currently being taken by all connected devices.
type StopAllDevices struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
}

// Request for the server to start scanning for new devices.
type StartScanning struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
}

// Request for the server to stop scanning for new devices.
type StopScanning struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
}

// Message sent by the server that is not in direct reply to a message send from
// the client, and always uses system Id.
type SystemIDMessage struct {
	// 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"`
}

// Server notification to client that scanning has ended.
type ScanningFinished struct {
	// 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"`
}

// Request for server to stream log messages of a certain level to client.
type RequestLog struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Maximum level of log message to receive.
	LogLevel string `json:"LogLevel"`
}

// Log message from the server.
type Log struct {
	// 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"`
	// Log level of message.
	LogLevel string `json:"LogLevel"`
	// Log message from server.
	LogMessage string `json:"LogMessage"`
}

// Request server version, and relay client name.
type RequestServerInfo struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Name of the client software.
	ClientName string `json:"ClientName"`
	// Message template version of the client software.
	MessageVersion int `json:"MessageVersion,omitempty"`
}

// Server version information, in Major.Minor.Build format.
type ServerInfo struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Name of the server. Can be 0-length.
	ServerName string `json:"ServerName"`
	// Message template version of the server software.
	MessageVersion int `json:"MessageVersion"`
	// Major version of server.
	MajorVersion int `json:"MajorVersion,omitempty"`
	// Minor version of server.
	MinorVersion int `json:"MinorVersion,omitempty"`
	// Build version of server.
	BuildVersion int `json:"BuildVersion,omitempty"`
	// Maximum time (in milliseconds) the server will wait between ping messages
	// from client before shutting down.
	MaxPingTime int `json:"MaxPingTime"`
}

// Sends speed and position command to the Fleshlight Launch Device denoted by
// the device index.
type FleshlightLaunchFW12Cmd struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Speed at which to move to designated position.
	Speed int `json:"Speed"`
	// Position to which to move Fleshlight.
	Position int `json:"Position"`
}

// Sends a command string to a Lovense device. Command string will be verified
// by sender.
type LovenseCmd struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Command to send to Lovense device.
	Command string `json:"Command"`
}

// Sends a vibrate command to a device that supports vibration.
type SingleMotorVibrateCmd struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Device vibration speed (floating point, 0 < x < 1), stepping will be
	// device specific.
	Speed float64 `json:"Speed"`
}

// Sends a raw byte string to a Kiiroo Onyx/Pearl device.
type KiirooCmd struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Command to send to Kiiroo device.
	Command string `json:"Command"`
}

// Request a raw byte array from a device. Should only be used for
// testing/development.
type RawReadCmd struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Endpoint (from device config file) from which the data was retrieved.
	Endpoint string `json:"Endpoint"`
	// Amount of data to read from device, 0 to exhaust whatever is in immediate
	// buffer
	Length int `json:"Length"`
	// If true, then wait until Length amount of data is available.
	WaitForData bool `json:"WaitForData"`
}

// Sends a raw byte array to a device. Should only be used for
// testing/development.
type RawWriteCmd struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Endpoint (from device config file) to send command to.
	Endpoint string `json:"Endpoint"`
	// Raw byte string to send to device.
	Data []int `json:"Data"`
	// If true, BLE writes will use WriteWithResponse. Value ignored for all
	// other types.
	WriteWithResponse bool `json:"WriteWithResponse"`
}

// Subscribe to an endpoint on a device to receive raw info back.
type RawSubscribeCmd struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Endpoint (from device config file) from which the data was retrieved.
	Endpoint string `json:"Endpoint"`
}

// Unsubscribe to an endpoint on a device.
type RawUnsubscribeCmd struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Endpoint (from device config file) from which the data was retrieved.
	Endpoint string `json:"Endpoint"`
}

// Raw byte array received from a device. Should only be used for
// testing/development.
type RawReading struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Endpoint (from device config file) from which the data was retrieved.
	Endpoint string `json:"Endpoint"`
	// Raw byte string received from device.
	Data []int `json:"Data"`
}

// Sends a raw byte string to a Kiiroo Onyx/Pearl device.
type VorzeA10CycloneCmd struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Rotation speed command for the Cyclone.
	Speed int `json:"Speed"`
	// True for clockwise rotation (in relation to device facing user), false
	// for Counter-clockwise
	Clockwise bool `json:"Clockwise"`
}

// Sends a vibrate command to a device that supports vibration.
type VibrateCmd struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Device vibration speeds (floating point, 0 < x < 1) keyed on vibrator
	// number, stepping will be device specific.
	Speeds []struct {
		// Vibrator number.
		Index int `json:"Index"`
		// Vibration speed (floating point, 0 < x < 1), stepping will be device
		// specific.
		Speed float64 `json:"Speed"`
	} `json:"Speeds"`
}

// Sends a rotate command to a device that supports rotation.
type RotateCmd struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Device rotation speeds (floating point, 0 < x < 1) keyed on rotator
	// number, stepping will be device specific.
	Rotations []struct {
		// Rotator number.
		Index int `json:"Index"`
		// Rotation speed (floating point, 0 < x < 1), stepping will be device
		// specific.
		Speed float64 `json:"Speed"`
		// Rotation direction (boolean). Not all devices have a concept of actual
		// clockwise.
		Clockwise bool `json:"Clockwise"`
	} `json:"Rotations"`
}

// Sends a linear movement command to a device that supports linear movements.
type LinearCmd struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Device linear movement times (milliseconds) and positions (floating
	// point, 0 < x < 1) keyed on linear actuator number, stepping will be
	// device specific.
	Vectors []struct {
		// Linear actuator number.
		Index int `json:"Index"`
		// Linear movement time in milliseconds.
		Duration float64 `json:"Duration"`
		// Linear movement position (floating point, 0 < x < 1), stepping will be
		// device specific.
		Position float64 `json:"Position"`
	} `json:"Vectors"`
}

// Requests that a BatteryLevel be retreived.
type BatteryLevelCmd struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
}

// Returns a BatteryLevel read from a device.
type BatteryLevelReading struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// Battery Level
	BatteryLevel float64 `json:"BatteryLevel"`
}

// Requests that a RSSI level be retreived.
type RSSILevelCmd struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
}

// Returns a BatteryLevel read from a device.
type RSSILevelReading struct {
	// User-set id for the message. 0 denotes system message and is reserved.
	ID ID `json:"Id"`
	// Index used for referencing the device in device messages.
	DeviceIndex DeviceIndex `json:"DeviceIndex"`
	// RSSI Level
	RSSILevel float64 `json:"RSSILevel"`
}