model

package
v0.0.0-...-0ff7356 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 6, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var PinModeValues []PinMode

Functions

func FirmataCommandParse

func FirmataCommandParse[T FirmataCommand](ctx context.Context, theBytes []byte, response bool) (T, error)

func FirmataCommandParseWithBuffer

func FirmataCommandParseWithBuffer[T FirmataCommand](ctx context.Context, readBuffer utils.ReadBuffer, response bool) (T, error)

func FirmataCommandParseWithBufferProducer

func FirmataCommandParseWithBufferProducer[T FirmataCommand](response bool) func(ctx context.Context, readBuffer utils.ReadBuffer) (T, error)

func FirmataMessageParse

func FirmataMessageParse[T FirmataMessage](ctx context.Context, theBytes []byte, response bool) (T, error)

func FirmataMessageParseWithBuffer

func FirmataMessageParseWithBuffer[T FirmataMessage](ctx context.Context, readBuffer utils.ReadBuffer, response bool) (T, error)

func FirmataMessageParseWithBufferProducer

func FirmataMessageParseWithBufferProducer[T FirmataMessage](response bool) func(ctx context.Context, readBuffer utils.ReadBuffer) (T, error)

func IsSysexEnd

func IsSysexEnd(ctx context.Context, io utils.ReadBuffer) func([]byte) bool

func LengthSysexString

func LengthSysexString(ctx context.Context, data []byte) uint16

func NewFirmataCommand

func NewFirmataCommand() *_FirmataCommand

NewFirmataCommand factory function for _FirmataCommand

func NewFirmataCommandProtocolVersion

func NewFirmataCommandProtocolVersion(majorVersion uint8, minorVersion uint8) *_FirmataCommandProtocolVersion

NewFirmataCommandProtocolVersion factory function for _FirmataCommandProtocolVersion

func NewFirmataCommandSetDigitalPinValue

func NewFirmataCommandSetDigitalPinValue(pin uint8, on bool) *_FirmataCommandSetDigitalPinValue

NewFirmataCommandSetDigitalPinValue factory function for _FirmataCommandSetDigitalPinValue

func NewFirmataCommandSetPinMode

func NewFirmataCommandSetPinMode(pin uint8, mode PinMode) *_FirmataCommandSetPinMode

NewFirmataCommandSetPinMode factory function for _FirmataCommandSetPinMode

func NewFirmataCommandSysex

func NewFirmataCommandSysex(command SysexCommand) *_FirmataCommandSysex

NewFirmataCommandSysex factory function for _FirmataCommandSysex

func NewFirmataCommandSystemReset

func NewFirmataCommandSystemReset() *_FirmataCommandSystemReset

NewFirmataCommandSystemReset factory function for _FirmataCommandSystemReset

func NewFirmataMessage

func NewFirmataMessage() *_FirmataMessage

NewFirmataMessage factory function for _FirmataMessage

func NewFirmataMessageAnalogIO

func NewFirmataMessageAnalogIO(pin uint8, data []int8) *_FirmataMessageAnalogIO

NewFirmataMessageAnalogIO factory function for _FirmataMessageAnalogIO

func NewFirmataMessageCommand

func NewFirmataMessageCommand(command FirmataCommand) *_FirmataMessageCommand

NewFirmataMessageCommand factory function for _FirmataMessageCommand

func NewFirmataMessageDigitalIO

func NewFirmataMessageDigitalIO(pinBlock uint8, data []int8) *_FirmataMessageDigitalIO

NewFirmataMessageDigitalIO factory function for _FirmataMessageDigitalIO

func NewFirmataMessageSubscribeAnalogPinValue

func NewFirmataMessageSubscribeAnalogPinValue(pin uint8, enable bool) *_FirmataMessageSubscribeAnalogPinValue

NewFirmataMessageSubscribeAnalogPinValue factory function for _FirmataMessageSubscribeAnalogPinValue

func NewFirmataMessageSubscribeDigitalPinValue

func NewFirmataMessageSubscribeDigitalPinValue(pin uint8, enable bool) *_FirmataMessageSubscribeDigitalPinValue

NewFirmataMessageSubscribeDigitalPinValue factory function for _FirmataMessageSubscribeDigitalPinValue

func NewSysexCommand

func NewSysexCommand() *_SysexCommand

NewSysexCommand factory function for _SysexCommand

func NewSysexCommandAnalogMappingQueryRequest

func NewSysexCommandAnalogMappingQueryRequest() *_SysexCommandAnalogMappingQueryRequest

NewSysexCommandAnalogMappingQueryRequest factory function for _SysexCommandAnalogMappingQueryRequest

func NewSysexCommandAnalogMappingQueryResponse

func NewSysexCommandAnalogMappingQueryResponse(pin uint8) *_SysexCommandAnalogMappingQueryResponse

NewSysexCommandAnalogMappingQueryResponse factory function for _SysexCommandAnalogMappingQueryResponse

func NewSysexCommandAnalogMappingResponse

func NewSysexCommandAnalogMappingResponse() *_SysexCommandAnalogMappingResponse

NewSysexCommandAnalogMappingResponse factory function for _SysexCommandAnalogMappingResponse

func NewSysexCommandCapabilityQuery

func NewSysexCommandCapabilityQuery() *_SysexCommandCapabilityQuery

NewSysexCommandCapabilityQuery factory function for _SysexCommandCapabilityQuery

func NewSysexCommandCapabilityResponse

func NewSysexCommandCapabilityResponse() *_SysexCommandCapabilityResponse

NewSysexCommandCapabilityResponse factory function for _SysexCommandCapabilityResponse

func NewSysexCommandExtendedAnalog

func NewSysexCommandExtendedAnalog() *_SysexCommandExtendedAnalog

NewSysexCommandExtendedAnalog factory function for _SysexCommandExtendedAnalog

func NewSysexCommandExtendedId

func NewSysexCommandExtendedId(id []int8) *_SysexCommandExtendedId

NewSysexCommandExtendedId factory function for _SysexCommandExtendedId

func NewSysexCommandPinStateQuery

func NewSysexCommandPinStateQuery(pin uint8) *_SysexCommandPinStateQuery

NewSysexCommandPinStateQuery factory function for _SysexCommandPinStateQuery

func NewSysexCommandPinStateResponse

func NewSysexCommandPinStateResponse(pin uint8, pinMode uint8, pinState uint8) *_SysexCommandPinStateResponse

NewSysexCommandPinStateResponse factory function for _SysexCommandPinStateResponse

func NewSysexCommandReportFirmwareRequest

func NewSysexCommandReportFirmwareRequest() *_SysexCommandReportFirmwareRequest

NewSysexCommandReportFirmwareRequest factory function for _SysexCommandReportFirmwareRequest

func NewSysexCommandReportFirmwareResponse

func NewSysexCommandReportFirmwareResponse(majorVersion uint8, minorVersion uint8, fileName []byte) *_SysexCommandReportFirmwareResponse

NewSysexCommandReportFirmwareResponse factory function for _SysexCommandReportFirmwareResponse

func NewSysexCommandSamplingInterval

func NewSysexCommandSamplingInterval() *_SysexCommandSamplingInterval

NewSysexCommandSamplingInterval factory function for _SysexCommandSamplingInterval

func NewSysexCommandStringData

func NewSysexCommandStringData() *_SysexCommandStringData

NewSysexCommandStringData factory function for _SysexCommandStringData

func NewSysexCommandSysexNonRealtime

func NewSysexCommandSysexNonRealtime() *_SysexCommandSysexNonRealtime

NewSysexCommandSysexNonRealtime factory function for _SysexCommandSysexNonRealtime

func NewSysexCommandSysexRealtime

func NewSysexCommandSysexRealtime() *_SysexCommandSysexRealtime

NewSysexCommandSysexRealtime factory function for _SysexCommandSysexRealtime

func ParseSysexString

func ParseSysexString(ctx context.Context, io utils.ReadBuffer) func(context.Context) (byte, error)

func PinModeKnows

func PinModeKnows(value uint8) bool

func SerializeSysexString

func SerializeSysexString(ctx context.Context, io utils.WriteBuffer, data byte) error

func SysexCommandParse

func SysexCommandParse[T SysexCommand](ctx context.Context, theBytes []byte, response bool) (T, error)

func SysexCommandParseWithBuffer

func SysexCommandParseWithBuffer[T SysexCommand](ctx context.Context, readBuffer utils.ReadBuffer, response bool) (T, error)

func SysexCommandParseWithBufferProducer

func SysexCommandParseWithBufferProducer[T SysexCommand](response bool) func(ctx context.Context, readBuffer utils.ReadBuffer) (T, error)

Types

type FirmataCommand

type FirmataCommand interface {
	FirmataCommandContract
	FirmataCommandRequirements
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	// IsFirmataCommand is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsFirmataCommand()
	// CreateBuilder creates a FirmataCommandBuilder
	CreateFirmataCommandBuilder() FirmataCommandBuilder
}

FirmataCommand is the corresponding interface of FirmataCommand

func CastFirmataCommand deprecated

func CastFirmataCommand(structType any) FirmataCommand

Deprecated: use the interface for direct cast

type FirmataCommandBuilder

type FirmataCommandBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() FirmataCommandBuilder
	// AsFirmataCommandSysex converts this build to a subType of FirmataCommand. It is always possible to return to current builder using Done()
	AsFirmataCommandSysex() FirmataCommandSysexBuilder
	// AsFirmataCommandSetPinMode converts this build to a subType of FirmataCommand. It is always possible to return to current builder using Done()
	AsFirmataCommandSetPinMode() FirmataCommandSetPinModeBuilder
	// AsFirmataCommandSetDigitalPinValue converts this build to a subType of FirmataCommand. It is always possible to return to current builder using Done()
	AsFirmataCommandSetDigitalPinValue() FirmataCommandSetDigitalPinValueBuilder
	// AsFirmataCommandProtocolVersion converts this build to a subType of FirmataCommand. It is always possible to return to current builder using Done()
	AsFirmataCommandProtocolVersion() FirmataCommandProtocolVersionBuilder
	// AsFirmataCommandSystemReset converts this build to a subType of FirmataCommand. It is always possible to return to current builder using Done()
	AsFirmataCommandSystemReset() FirmataCommandSystemResetBuilder
	// Build builds the FirmataCommand or returns an error if something is wrong
	PartialBuild() (FirmataCommandContract, error)
	// MustBuild does the same as Build but panics on error
	PartialMustBuild() FirmataCommandContract
	// Build builds the FirmataCommand or returns an error if something is wrong
	Build() (FirmataCommand, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() FirmataCommand
}

FirmataCommandBuilder is a builder for FirmataCommand

func NewFirmataCommandBuilder

func NewFirmataCommandBuilder() FirmataCommandBuilder

NewFirmataCommandBuilder() creates a FirmataCommandBuilder

type FirmataCommandContract

type FirmataCommandContract interface {
	// IsFirmataCommand is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsFirmataCommand()
	// CreateBuilder creates a FirmataCommandBuilder
	CreateFirmataCommandBuilder() FirmataCommandBuilder
}

FirmataCommandContract provides a set of functions which can be overwritten by a sub struct

type FirmataCommandProtocolVersion

type FirmataCommandProtocolVersion interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	FirmataCommand
	// GetMajorVersion returns MajorVersion (property field)
	GetMajorVersion() uint8
	// GetMinorVersion returns MinorVersion (property field)
	GetMinorVersion() uint8
	// IsFirmataCommandProtocolVersion is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsFirmataCommandProtocolVersion()
	// CreateBuilder creates a FirmataCommandProtocolVersionBuilder
	CreateFirmataCommandProtocolVersionBuilder() FirmataCommandProtocolVersionBuilder
}

FirmataCommandProtocolVersion is the corresponding interface of FirmataCommandProtocolVersion

func CastFirmataCommandProtocolVersion deprecated

func CastFirmataCommandProtocolVersion(structType any) FirmataCommandProtocolVersion

Deprecated: use the interface for direct cast

type FirmataCommandProtocolVersionBuilder

type FirmataCommandProtocolVersionBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(majorVersion uint8, minorVersion uint8) FirmataCommandProtocolVersionBuilder
	// WithMajorVersion adds MajorVersion (property field)
	WithMajorVersion(uint8) FirmataCommandProtocolVersionBuilder
	// WithMinorVersion adds MinorVersion (property field)
	WithMinorVersion(uint8) FirmataCommandProtocolVersionBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() FirmataCommandBuilder
	// Build builds the FirmataCommandProtocolVersion or returns an error if something is wrong
	Build() (FirmataCommandProtocolVersion, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() FirmataCommandProtocolVersion
}

FirmataCommandProtocolVersionBuilder is a builder for FirmataCommandProtocolVersion

func NewFirmataCommandProtocolVersionBuilder

func NewFirmataCommandProtocolVersionBuilder() FirmataCommandProtocolVersionBuilder

NewFirmataCommandProtocolVersionBuilder() creates a FirmataCommandProtocolVersionBuilder

type FirmataCommandRequirements

type FirmataCommandRequirements interface {
	GetLengthInBits(ctx context.Context) uint16
	GetLengthInBytes(ctx context.Context) uint16
	// GetCommandCode returns CommandCode (discriminator field)
	GetCommandCode() uint8
}

FirmataCommandRequirements provides a set of functions which need to be implemented by a sub struct

type FirmataCommandSetDigitalPinValue

type FirmataCommandSetDigitalPinValue interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	FirmataCommand
	// GetPin returns Pin (property field)
	GetPin() uint8
	// GetOn returns On (property field)
	GetOn() bool
	// IsFirmataCommandSetDigitalPinValue is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsFirmataCommandSetDigitalPinValue()
	// CreateBuilder creates a FirmataCommandSetDigitalPinValueBuilder
	CreateFirmataCommandSetDigitalPinValueBuilder() FirmataCommandSetDigitalPinValueBuilder
}

FirmataCommandSetDigitalPinValue is the corresponding interface of FirmataCommandSetDigitalPinValue

func CastFirmataCommandSetDigitalPinValue deprecated

func CastFirmataCommandSetDigitalPinValue(structType any) FirmataCommandSetDigitalPinValue

Deprecated: use the interface for direct cast

type FirmataCommandSetDigitalPinValueBuilder

type FirmataCommandSetDigitalPinValueBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(pin uint8, on bool) FirmataCommandSetDigitalPinValueBuilder
	// WithPin adds Pin (property field)
	WithPin(uint8) FirmataCommandSetDigitalPinValueBuilder
	// WithOn adds On (property field)
	WithOn(bool) FirmataCommandSetDigitalPinValueBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() FirmataCommandBuilder
	// Build builds the FirmataCommandSetDigitalPinValue or returns an error if something is wrong
	Build() (FirmataCommandSetDigitalPinValue, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() FirmataCommandSetDigitalPinValue
}

FirmataCommandSetDigitalPinValueBuilder is a builder for FirmataCommandSetDigitalPinValue

func NewFirmataCommandSetDigitalPinValueBuilder

func NewFirmataCommandSetDigitalPinValueBuilder() FirmataCommandSetDigitalPinValueBuilder

NewFirmataCommandSetDigitalPinValueBuilder() creates a FirmataCommandSetDigitalPinValueBuilder

type FirmataCommandSetPinMode

type FirmataCommandSetPinMode interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	FirmataCommand
	// GetPin returns Pin (property field)
	GetPin() uint8
	// GetMode returns Mode (property field)
	GetMode() PinMode
	// IsFirmataCommandSetPinMode is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsFirmataCommandSetPinMode()
	// CreateBuilder creates a FirmataCommandSetPinModeBuilder
	CreateFirmataCommandSetPinModeBuilder() FirmataCommandSetPinModeBuilder
}

FirmataCommandSetPinMode is the corresponding interface of FirmataCommandSetPinMode

func CastFirmataCommandSetPinMode deprecated

func CastFirmataCommandSetPinMode(structType any) FirmataCommandSetPinMode

Deprecated: use the interface for direct cast

type FirmataCommandSetPinModeBuilder

type FirmataCommandSetPinModeBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(pin uint8, mode PinMode) FirmataCommandSetPinModeBuilder
	// WithPin adds Pin (property field)
	WithPin(uint8) FirmataCommandSetPinModeBuilder
	// WithMode adds Mode (property field)
	WithMode(PinMode) FirmataCommandSetPinModeBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() FirmataCommandBuilder
	// Build builds the FirmataCommandSetPinMode or returns an error if something is wrong
	Build() (FirmataCommandSetPinMode, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() FirmataCommandSetPinMode
}

FirmataCommandSetPinModeBuilder is a builder for FirmataCommandSetPinMode

func NewFirmataCommandSetPinModeBuilder

func NewFirmataCommandSetPinModeBuilder() FirmataCommandSetPinModeBuilder

NewFirmataCommandSetPinModeBuilder() creates a FirmataCommandSetPinModeBuilder

type FirmataCommandSysex

type FirmataCommandSysex interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	FirmataCommand
	// GetCommand returns Command (property field)
	GetCommand() SysexCommand
	// IsFirmataCommandSysex is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsFirmataCommandSysex()
	// CreateBuilder creates a FirmataCommandSysexBuilder
	CreateFirmataCommandSysexBuilder() FirmataCommandSysexBuilder
}

FirmataCommandSysex is the corresponding interface of FirmataCommandSysex

func CastFirmataCommandSysex deprecated

func CastFirmataCommandSysex(structType any) FirmataCommandSysex

Deprecated: use the interface for direct cast

type FirmataCommandSysexBuilder

type FirmataCommandSysexBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(command SysexCommand) FirmataCommandSysexBuilder
	// WithCommand adds Command (property field)
	WithCommand(SysexCommand) FirmataCommandSysexBuilder
	// WithCommandBuilder adds Command (property field) which is build by the builder
	WithCommandBuilder(func(SysexCommandBuilder) SysexCommandBuilder) FirmataCommandSysexBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() FirmataCommandBuilder
	// Build builds the FirmataCommandSysex or returns an error if something is wrong
	Build() (FirmataCommandSysex, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() FirmataCommandSysex
}

FirmataCommandSysexBuilder is a builder for FirmataCommandSysex

func NewFirmataCommandSysexBuilder

func NewFirmataCommandSysexBuilder() FirmataCommandSysexBuilder

NewFirmataCommandSysexBuilder() creates a FirmataCommandSysexBuilder

type FirmataCommandSystemReset

type FirmataCommandSystemReset interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	FirmataCommand
	// IsFirmataCommandSystemReset is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsFirmataCommandSystemReset()
	// CreateBuilder creates a FirmataCommandSystemResetBuilder
	CreateFirmataCommandSystemResetBuilder() FirmataCommandSystemResetBuilder
}

FirmataCommandSystemReset is the corresponding interface of FirmataCommandSystemReset

func CastFirmataCommandSystemReset deprecated

func CastFirmataCommandSystemReset(structType any) FirmataCommandSystemReset

Deprecated: use the interface for direct cast

type FirmataCommandSystemResetBuilder

type FirmataCommandSystemResetBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() FirmataCommandSystemResetBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() FirmataCommandBuilder
	// Build builds the FirmataCommandSystemReset or returns an error if something is wrong
	Build() (FirmataCommandSystemReset, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() FirmataCommandSystemReset
}

FirmataCommandSystemResetBuilder is a builder for FirmataCommandSystemReset

func NewFirmataCommandSystemResetBuilder

func NewFirmataCommandSystemResetBuilder() FirmataCommandSystemResetBuilder

NewFirmataCommandSystemResetBuilder() creates a FirmataCommandSystemResetBuilder

type FirmataMessage

type FirmataMessage interface {
	FirmataMessageContract
	FirmataMessageRequirements
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	// IsFirmataMessage is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsFirmataMessage()
	// CreateBuilder creates a FirmataMessageBuilder
	CreateFirmataMessageBuilder() FirmataMessageBuilder
}

FirmataMessage is the corresponding interface of FirmataMessage

func CastFirmataMessage deprecated

func CastFirmataMessage(structType any) FirmataMessage

Deprecated: use the interface for direct cast

type FirmataMessageAnalogIO

type FirmataMessageAnalogIO interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	FirmataMessage
	// GetPin returns Pin (property field)
	GetPin() uint8
	// GetData returns Data (property field)
	GetData() []int8
	// IsFirmataMessageAnalogIO is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsFirmataMessageAnalogIO()
	// CreateBuilder creates a FirmataMessageAnalogIOBuilder
	CreateFirmataMessageAnalogIOBuilder() FirmataMessageAnalogIOBuilder
}

FirmataMessageAnalogIO is the corresponding interface of FirmataMessageAnalogIO Reading operations Data-Format is: in both bytes only the least significant 7 bits count (unsigned 14 bit integer number) The first byte contains the least significant part The second byte contains the most significant part

func CastFirmataMessageAnalogIO deprecated

func CastFirmataMessageAnalogIO(structType any) FirmataMessageAnalogIO

Deprecated: use the interface for direct cast

type FirmataMessageAnalogIOBuilder

type FirmataMessageAnalogIOBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(pin uint8, data []int8) FirmataMessageAnalogIOBuilder
	// WithPin adds Pin (property field)
	WithPin(uint8) FirmataMessageAnalogIOBuilder
	// WithData adds Data (property field)
	WithData(...int8) FirmataMessageAnalogIOBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() FirmataMessageBuilder
	// Build builds the FirmataMessageAnalogIO or returns an error if something is wrong
	Build() (FirmataMessageAnalogIO, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() FirmataMessageAnalogIO
}

FirmataMessageAnalogIOBuilder is a builder for FirmataMessageAnalogIO

func NewFirmataMessageAnalogIOBuilder

func NewFirmataMessageAnalogIOBuilder() FirmataMessageAnalogIOBuilder

NewFirmataMessageAnalogIOBuilder() creates a FirmataMessageAnalogIOBuilder

type FirmataMessageBuilder

type FirmataMessageBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() FirmataMessageBuilder
	// AsFirmataMessageAnalogIO converts this build to a subType of FirmataMessage. It is always possible to return to current builder using Done()
	AsFirmataMessageAnalogIO() FirmataMessageAnalogIOBuilder
	// AsFirmataMessageDigitalIO converts this build to a subType of FirmataMessage. It is always possible to return to current builder using Done()
	AsFirmataMessageDigitalIO() FirmataMessageDigitalIOBuilder
	// AsFirmataMessageSubscribeAnalogPinValue converts this build to a subType of FirmataMessage. It is always possible to return to current builder using Done()
	AsFirmataMessageSubscribeAnalogPinValue() FirmataMessageSubscribeAnalogPinValueBuilder
	// AsFirmataMessageSubscribeDigitalPinValue converts this build to a subType of FirmataMessage. It is always possible to return to current builder using Done()
	AsFirmataMessageSubscribeDigitalPinValue() FirmataMessageSubscribeDigitalPinValueBuilder
	// AsFirmataMessageCommand converts this build to a subType of FirmataMessage. It is always possible to return to current builder using Done()
	AsFirmataMessageCommand() FirmataMessageCommandBuilder
	// Build builds the FirmataMessage or returns an error if something is wrong
	PartialBuild() (FirmataMessageContract, error)
	// MustBuild does the same as Build but panics on error
	PartialMustBuild() FirmataMessageContract
	// Build builds the FirmataMessage or returns an error if something is wrong
	Build() (FirmataMessage, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() FirmataMessage
}

FirmataMessageBuilder is a builder for FirmataMessage

func NewFirmataMessageBuilder

func NewFirmataMessageBuilder() FirmataMessageBuilder

NewFirmataMessageBuilder() creates a FirmataMessageBuilder

type FirmataMessageCommand

type FirmataMessageCommand interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	FirmataMessage
	// GetCommand returns Command (property field)
	GetCommand() FirmataCommand
	// IsFirmataMessageCommand is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsFirmataMessageCommand()
	// CreateBuilder creates a FirmataMessageCommandBuilder
	CreateFirmataMessageCommandBuilder() FirmataMessageCommandBuilder
}

FirmataMessageCommand is the corresponding interface of FirmataMessageCommand Command

func CastFirmataMessageCommand deprecated

func CastFirmataMessageCommand(structType any) FirmataMessageCommand

Deprecated: use the interface for direct cast

type FirmataMessageCommandBuilder

type FirmataMessageCommandBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(command FirmataCommand) FirmataMessageCommandBuilder
	// WithCommand adds Command (property field)
	WithCommand(FirmataCommand) FirmataMessageCommandBuilder
	// WithCommandBuilder adds Command (property field) which is build by the builder
	WithCommandBuilder(func(FirmataCommandBuilder) FirmataCommandBuilder) FirmataMessageCommandBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() FirmataMessageBuilder
	// Build builds the FirmataMessageCommand or returns an error if something is wrong
	Build() (FirmataMessageCommand, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() FirmataMessageCommand
}

FirmataMessageCommandBuilder is a builder for FirmataMessageCommand

func NewFirmataMessageCommandBuilder

func NewFirmataMessageCommandBuilder() FirmataMessageCommandBuilder

NewFirmataMessageCommandBuilder() creates a FirmataMessageCommandBuilder

type FirmataMessageContract

type FirmataMessageContract interface {
	// IsFirmataMessage is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsFirmataMessage()
	// CreateBuilder creates a FirmataMessageBuilder
	CreateFirmataMessageBuilder() FirmataMessageBuilder
}

FirmataMessageContract provides a set of functions which can be overwritten by a sub struct

type FirmataMessageDigitalIO

type FirmataMessageDigitalIO interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	FirmataMessage
	// GetPinBlock returns PinBlock (property field)
	GetPinBlock() uint8
	// GetData returns Data (property field)
	GetData() []int8
	// IsFirmataMessageDigitalIO is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsFirmataMessageDigitalIO()
	// CreateBuilder creates a FirmataMessageDigitalIOBuilder
	CreateFirmataMessageDigitalIOBuilder() FirmataMessageDigitalIOBuilder
}

FirmataMessageDigitalIO is the corresponding interface of FirmataMessageDigitalIO Bitmask containing the first 7 bits in the least significant bits of the first byte and bit 8 in the second byte The 'pinBlock' refers to the block of bytes (0 refers to the first 8 pins, 1 to the second and so on.

func CastFirmataMessageDigitalIO deprecated

func CastFirmataMessageDigitalIO(structType any) FirmataMessageDigitalIO

Deprecated: use the interface for direct cast

type FirmataMessageDigitalIOBuilder

type FirmataMessageDigitalIOBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(pinBlock uint8, data []int8) FirmataMessageDigitalIOBuilder
	// WithPinBlock adds PinBlock (property field)
	WithPinBlock(uint8) FirmataMessageDigitalIOBuilder
	// WithData adds Data (property field)
	WithData(...int8) FirmataMessageDigitalIOBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() FirmataMessageBuilder
	// Build builds the FirmataMessageDigitalIO or returns an error if something is wrong
	Build() (FirmataMessageDigitalIO, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() FirmataMessageDigitalIO
}

FirmataMessageDigitalIOBuilder is a builder for FirmataMessageDigitalIO

func NewFirmataMessageDigitalIOBuilder

func NewFirmataMessageDigitalIOBuilder() FirmataMessageDigitalIOBuilder

NewFirmataMessageDigitalIOBuilder() creates a FirmataMessageDigitalIOBuilder

type FirmataMessageRequirements

type FirmataMessageRequirements interface {
	GetLengthInBits(ctx context.Context) uint16
	GetLengthInBytes(ctx context.Context) uint16
	// GetMessageType returns MessageType (discriminator field)
	GetMessageType() uint8
}

FirmataMessageRequirements provides a set of functions which need to be implemented by a sub struct

type FirmataMessageSubscribeAnalogPinValue

type FirmataMessageSubscribeAnalogPinValue interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	FirmataMessage
	// GetPin returns Pin (property field)
	GetPin() uint8
	// GetEnable returns Enable (property field)
	GetEnable() bool
	// IsFirmataMessageSubscribeAnalogPinValue is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsFirmataMessageSubscribeAnalogPinValue()
	// CreateBuilder creates a FirmataMessageSubscribeAnalogPinValueBuilder
	CreateFirmataMessageSubscribeAnalogPinValueBuilder() FirmataMessageSubscribeAnalogPinValueBuilder
}

FirmataMessageSubscribeAnalogPinValue is the corresponding interface of FirmataMessageSubscribeAnalogPinValue

func CastFirmataMessageSubscribeAnalogPinValue deprecated

func CastFirmataMessageSubscribeAnalogPinValue(structType any) FirmataMessageSubscribeAnalogPinValue

Deprecated: use the interface for direct cast

type FirmataMessageSubscribeAnalogPinValueBuilder

type FirmataMessageSubscribeAnalogPinValueBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(pin uint8, enable bool) FirmataMessageSubscribeAnalogPinValueBuilder
	// WithPin adds Pin (property field)
	WithPin(uint8) FirmataMessageSubscribeAnalogPinValueBuilder
	// WithEnable adds Enable (property field)
	WithEnable(bool) FirmataMessageSubscribeAnalogPinValueBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() FirmataMessageBuilder
	// Build builds the FirmataMessageSubscribeAnalogPinValue or returns an error if something is wrong
	Build() (FirmataMessageSubscribeAnalogPinValue, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() FirmataMessageSubscribeAnalogPinValue
}

FirmataMessageSubscribeAnalogPinValueBuilder is a builder for FirmataMessageSubscribeAnalogPinValue

func NewFirmataMessageSubscribeAnalogPinValueBuilder

func NewFirmataMessageSubscribeAnalogPinValueBuilder() FirmataMessageSubscribeAnalogPinValueBuilder

NewFirmataMessageSubscribeAnalogPinValueBuilder() creates a FirmataMessageSubscribeAnalogPinValueBuilder

type FirmataMessageSubscribeDigitalPinValue

type FirmataMessageSubscribeDigitalPinValue interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	FirmataMessage
	// GetPin returns Pin (property field)
	GetPin() uint8
	// GetEnable returns Enable (property field)
	GetEnable() bool
	// IsFirmataMessageSubscribeDigitalPinValue is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsFirmataMessageSubscribeDigitalPinValue()
	// CreateBuilder creates a FirmataMessageSubscribeDigitalPinValueBuilder
	CreateFirmataMessageSubscribeDigitalPinValueBuilder() FirmataMessageSubscribeDigitalPinValueBuilder
}

FirmataMessageSubscribeDigitalPinValue is the corresponding interface of FirmataMessageSubscribeDigitalPinValue

func CastFirmataMessageSubscribeDigitalPinValue deprecated

func CastFirmataMessageSubscribeDigitalPinValue(structType any) FirmataMessageSubscribeDigitalPinValue

Deprecated: use the interface for direct cast

type FirmataMessageSubscribeDigitalPinValueBuilder

type FirmataMessageSubscribeDigitalPinValueBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(pin uint8, enable bool) FirmataMessageSubscribeDigitalPinValueBuilder
	// WithPin adds Pin (property field)
	WithPin(uint8) FirmataMessageSubscribeDigitalPinValueBuilder
	// WithEnable adds Enable (property field)
	WithEnable(bool) FirmataMessageSubscribeDigitalPinValueBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() FirmataMessageBuilder
	// Build builds the FirmataMessageSubscribeDigitalPinValue or returns an error if something is wrong
	Build() (FirmataMessageSubscribeDigitalPinValue, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() FirmataMessageSubscribeDigitalPinValue
}

FirmataMessageSubscribeDigitalPinValueBuilder is a builder for FirmataMessageSubscribeDigitalPinValue

func NewFirmataMessageSubscribeDigitalPinValueBuilder

func NewFirmataMessageSubscribeDigitalPinValueBuilder() FirmataMessageSubscribeDigitalPinValueBuilder

NewFirmataMessageSubscribeDigitalPinValueBuilder() creates a FirmataMessageSubscribeDigitalPinValueBuilder

type IPinMode

type IPinMode interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
}

type PinMode

type PinMode uint8

PinMode is an enum

const (
	PinMode_PinModeInput   PinMode = 0x0
	PinMode_PinModeOutput  PinMode = 0x1
	PinMode_PinModeAnalog  PinMode = 0x2
	PinMode_PinModePwm     PinMode = 0x3
	PinMode_PinModeServo   PinMode = 0x4
	PinMode_PinModeShift   PinMode = 0x5
	PinMode_PinModeI2C     PinMode = 0x6
	PinMode_PinModeOneWire PinMode = 0x7
	PinMode_PinModeStepper PinMode = 0x8
	PinMode_PinModeEncoder PinMode = 0x9
	PinMode_PinModeSerial  PinMode = 0xA
	PinMode_PinModePullup  PinMode = 0xB
)

func CastPinMode

func CastPinMode(structType any) PinMode

func PinModeByName

func PinModeByName(value string) (enum PinMode, ok bool)

func PinModeByValue

func PinModeByValue(value uint8) (enum PinMode, ok bool)

func PinModeParse

func PinModeParse(ctx context.Context, theBytes []byte) (PinMode, error)

func PinModeParseWithBuffer

func PinModeParseWithBuffer(ctx context.Context, readBuffer utils.ReadBuffer) (PinMode, error)

func (PinMode) GetLengthInBits

func (m PinMode) GetLengthInBits(ctx context.Context) uint16

func (PinMode) GetLengthInBytes

func (m PinMode) GetLengthInBytes(ctx context.Context) uint16

func (PinMode) GetValue

func (e PinMode) GetValue() uint8

func (PinMode) PLC4XEnumName

func (e PinMode) PLC4XEnumName() string

PLC4XEnumName returns the name that is used in code to identify this enum

func (PinMode) Serialize

func (e PinMode) Serialize() ([]byte, error)

func (PinMode) SerializeWithWriteBuffer

func (e PinMode) SerializeWithWriteBuffer(ctx context.Context, writeBuffer utils.WriteBuffer) error

func (PinMode) String

func (e PinMode) String() string

type SysexCommand

type SysexCommand interface {
	SysexCommandContract
	SysexCommandRequirements
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	// IsSysexCommand is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommand()
	// CreateBuilder creates a SysexCommandBuilder
	CreateSysexCommandBuilder() SysexCommandBuilder
}

SysexCommand is the corresponding interface of SysexCommand

func CastSysexCommand deprecated

func CastSysexCommand(structType any) SysexCommand

Deprecated: use the interface for direct cast

type SysexCommandAnalogMappingQueryRequest

type SysexCommandAnalogMappingQueryRequest interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	SysexCommand
	// IsSysexCommandAnalogMappingQueryRequest is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommandAnalogMappingQueryRequest()
	// CreateBuilder creates a SysexCommandAnalogMappingQueryRequestBuilder
	CreateSysexCommandAnalogMappingQueryRequestBuilder() SysexCommandAnalogMappingQueryRequestBuilder
}

SysexCommandAnalogMappingQueryRequest is the corresponding interface of SysexCommandAnalogMappingQueryRequest

func CastSysexCommandAnalogMappingQueryRequest deprecated

func CastSysexCommandAnalogMappingQueryRequest(structType any) SysexCommandAnalogMappingQueryRequest

Deprecated: use the interface for direct cast

type SysexCommandAnalogMappingQueryRequestBuilder

type SysexCommandAnalogMappingQueryRequestBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() SysexCommandAnalogMappingQueryRequestBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() SysexCommandBuilder
	// Build builds the SysexCommandAnalogMappingQueryRequest or returns an error if something is wrong
	Build() (SysexCommandAnalogMappingQueryRequest, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommandAnalogMappingQueryRequest
}

SysexCommandAnalogMappingQueryRequestBuilder is a builder for SysexCommandAnalogMappingQueryRequest

func NewSysexCommandAnalogMappingQueryRequestBuilder

func NewSysexCommandAnalogMappingQueryRequestBuilder() SysexCommandAnalogMappingQueryRequestBuilder

NewSysexCommandAnalogMappingQueryRequestBuilder() creates a SysexCommandAnalogMappingQueryRequestBuilder

type SysexCommandAnalogMappingQueryResponse

type SysexCommandAnalogMappingQueryResponse interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	SysexCommand
	// GetPin returns Pin (property field)
	GetPin() uint8
	// IsSysexCommandAnalogMappingQueryResponse is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommandAnalogMappingQueryResponse()
	// CreateBuilder creates a SysexCommandAnalogMappingQueryResponseBuilder
	CreateSysexCommandAnalogMappingQueryResponseBuilder() SysexCommandAnalogMappingQueryResponseBuilder
}

SysexCommandAnalogMappingQueryResponse is the corresponding interface of SysexCommandAnalogMappingQueryResponse

func CastSysexCommandAnalogMappingQueryResponse deprecated

func CastSysexCommandAnalogMappingQueryResponse(structType any) SysexCommandAnalogMappingQueryResponse

Deprecated: use the interface for direct cast

type SysexCommandAnalogMappingQueryResponseBuilder

type SysexCommandAnalogMappingQueryResponseBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(pin uint8) SysexCommandAnalogMappingQueryResponseBuilder
	// WithPin adds Pin (property field)
	WithPin(uint8) SysexCommandAnalogMappingQueryResponseBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() SysexCommandBuilder
	// Build builds the SysexCommandAnalogMappingQueryResponse or returns an error if something is wrong
	Build() (SysexCommandAnalogMappingQueryResponse, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommandAnalogMappingQueryResponse
}

SysexCommandAnalogMappingQueryResponseBuilder is a builder for SysexCommandAnalogMappingQueryResponse

func NewSysexCommandAnalogMappingQueryResponseBuilder

func NewSysexCommandAnalogMappingQueryResponseBuilder() SysexCommandAnalogMappingQueryResponseBuilder

NewSysexCommandAnalogMappingQueryResponseBuilder() creates a SysexCommandAnalogMappingQueryResponseBuilder

type SysexCommandAnalogMappingResponse

type SysexCommandAnalogMappingResponse interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	SysexCommand
	// IsSysexCommandAnalogMappingResponse is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommandAnalogMappingResponse()
	// CreateBuilder creates a SysexCommandAnalogMappingResponseBuilder
	CreateSysexCommandAnalogMappingResponseBuilder() SysexCommandAnalogMappingResponseBuilder
}

SysexCommandAnalogMappingResponse is the corresponding interface of SysexCommandAnalogMappingResponse

func CastSysexCommandAnalogMappingResponse deprecated

func CastSysexCommandAnalogMappingResponse(structType any) SysexCommandAnalogMappingResponse

Deprecated: use the interface for direct cast

type SysexCommandAnalogMappingResponseBuilder

type SysexCommandAnalogMappingResponseBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() SysexCommandAnalogMappingResponseBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() SysexCommandBuilder
	// Build builds the SysexCommandAnalogMappingResponse or returns an error if something is wrong
	Build() (SysexCommandAnalogMappingResponse, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommandAnalogMappingResponse
}

SysexCommandAnalogMappingResponseBuilder is a builder for SysexCommandAnalogMappingResponse

func NewSysexCommandAnalogMappingResponseBuilder

func NewSysexCommandAnalogMappingResponseBuilder() SysexCommandAnalogMappingResponseBuilder

NewSysexCommandAnalogMappingResponseBuilder() creates a SysexCommandAnalogMappingResponseBuilder

type SysexCommandBuilder

type SysexCommandBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() SysexCommandBuilder
	// AsSysexCommandExtendedId converts this build to a subType of SysexCommand. It is always possible to return to current builder using Done()
	AsSysexCommandExtendedId() SysexCommandExtendedIdBuilder
	// AsSysexCommandAnalogMappingQueryRequest converts this build to a subType of SysexCommand. It is always possible to return to current builder using Done()
	AsSysexCommandAnalogMappingQueryRequest() SysexCommandAnalogMappingQueryRequestBuilder
	// AsSysexCommandAnalogMappingQueryResponse converts this build to a subType of SysexCommand. It is always possible to return to current builder using Done()
	AsSysexCommandAnalogMappingQueryResponse() SysexCommandAnalogMappingQueryResponseBuilder
	// AsSysexCommandAnalogMappingResponse converts this build to a subType of SysexCommand. It is always possible to return to current builder using Done()
	AsSysexCommandAnalogMappingResponse() SysexCommandAnalogMappingResponseBuilder
	// AsSysexCommandCapabilityQuery converts this build to a subType of SysexCommand. It is always possible to return to current builder using Done()
	AsSysexCommandCapabilityQuery() SysexCommandCapabilityQueryBuilder
	// AsSysexCommandCapabilityResponse converts this build to a subType of SysexCommand. It is always possible to return to current builder using Done()
	AsSysexCommandCapabilityResponse() SysexCommandCapabilityResponseBuilder
	// AsSysexCommandPinStateQuery converts this build to a subType of SysexCommand. It is always possible to return to current builder using Done()
	AsSysexCommandPinStateQuery() SysexCommandPinStateQueryBuilder
	// AsSysexCommandPinStateResponse converts this build to a subType of SysexCommand. It is always possible to return to current builder using Done()
	AsSysexCommandPinStateResponse() SysexCommandPinStateResponseBuilder
	// AsSysexCommandExtendedAnalog converts this build to a subType of SysexCommand. It is always possible to return to current builder using Done()
	AsSysexCommandExtendedAnalog() SysexCommandExtendedAnalogBuilder
	// AsSysexCommandStringData converts this build to a subType of SysexCommand. It is always possible to return to current builder using Done()
	AsSysexCommandStringData() SysexCommandStringDataBuilder
	// AsSysexCommandReportFirmwareRequest converts this build to a subType of SysexCommand. It is always possible to return to current builder using Done()
	AsSysexCommandReportFirmwareRequest() SysexCommandReportFirmwareRequestBuilder
	// AsSysexCommandReportFirmwareResponse converts this build to a subType of SysexCommand. It is always possible to return to current builder using Done()
	AsSysexCommandReportFirmwareResponse() SysexCommandReportFirmwareResponseBuilder
	// AsSysexCommandSamplingInterval converts this build to a subType of SysexCommand. It is always possible to return to current builder using Done()
	AsSysexCommandSamplingInterval() SysexCommandSamplingIntervalBuilder
	// AsSysexCommandSysexNonRealtime converts this build to a subType of SysexCommand. It is always possible to return to current builder using Done()
	AsSysexCommandSysexNonRealtime() SysexCommandSysexNonRealtimeBuilder
	// AsSysexCommandSysexRealtime converts this build to a subType of SysexCommand. It is always possible to return to current builder using Done()
	AsSysexCommandSysexRealtime() SysexCommandSysexRealtimeBuilder
	// Build builds the SysexCommand or returns an error if something is wrong
	PartialBuild() (SysexCommandContract, error)
	// MustBuild does the same as Build but panics on error
	PartialMustBuild() SysexCommandContract
	// Build builds the SysexCommand or returns an error if something is wrong
	Build() (SysexCommand, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommand
}

SysexCommandBuilder is a builder for SysexCommand

func NewSysexCommandBuilder

func NewSysexCommandBuilder() SysexCommandBuilder

NewSysexCommandBuilder() creates a SysexCommandBuilder

type SysexCommandCapabilityQuery

type SysexCommandCapabilityQuery interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	SysexCommand
	// IsSysexCommandCapabilityQuery is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommandCapabilityQuery()
	// CreateBuilder creates a SysexCommandCapabilityQueryBuilder
	CreateSysexCommandCapabilityQueryBuilder() SysexCommandCapabilityQueryBuilder
}

SysexCommandCapabilityQuery is the corresponding interface of SysexCommandCapabilityQuery

func CastSysexCommandCapabilityQuery deprecated

func CastSysexCommandCapabilityQuery(structType any) SysexCommandCapabilityQuery

Deprecated: use the interface for direct cast

type SysexCommandCapabilityQueryBuilder

type SysexCommandCapabilityQueryBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() SysexCommandCapabilityQueryBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() SysexCommandBuilder
	// Build builds the SysexCommandCapabilityQuery or returns an error if something is wrong
	Build() (SysexCommandCapabilityQuery, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommandCapabilityQuery
}

SysexCommandCapabilityQueryBuilder is a builder for SysexCommandCapabilityQuery

func NewSysexCommandCapabilityQueryBuilder

func NewSysexCommandCapabilityQueryBuilder() SysexCommandCapabilityQueryBuilder

NewSysexCommandCapabilityQueryBuilder() creates a SysexCommandCapabilityQueryBuilder

type SysexCommandCapabilityResponse

type SysexCommandCapabilityResponse interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	SysexCommand
	// IsSysexCommandCapabilityResponse is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommandCapabilityResponse()
	// CreateBuilder creates a SysexCommandCapabilityResponseBuilder
	CreateSysexCommandCapabilityResponseBuilder() SysexCommandCapabilityResponseBuilder
}

SysexCommandCapabilityResponse is the corresponding interface of SysexCommandCapabilityResponse

func CastSysexCommandCapabilityResponse deprecated

func CastSysexCommandCapabilityResponse(structType any) SysexCommandCapabilityResponse

Deprecated: use the interface for direct cast

type SysexCommandCapabilityResponseBuilder

type SysexCommandCapabilityResponseBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() SysexCommandCapabilityResponseBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() SysexCommandBuilder
	// Build builds the SysexCommandCapabilityResponse or returns an error if something is wrong
	Build() (SysexCommandCapabilityResponse, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommandCapabilityResponse
}

SysexCommandCapabilityResponseBuilder is a builder for SysexCommandCapabilityResponse

func NewSysexCommandCapabilityResponseBuilder

func NewSysexCommandCapabilityResponseBuilder() SysexCommandCapabilityResponseBuilder

NewSysexCommandCapabilityResponseBuilder() creates a SysexCommandCapabilityResponseBuilder

type SysexCommandContract

type SysexCommandContract interface {
	// IsSysexCommand is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommand()
	// CreateBuilder creates a SysexCommandBuilder
	CreateSysexCommandBuilder() SysexCommandBuilder
}

SysexCommandContract provides a set of functions which can be overwritten by a sub struct

type SysexCommandExtendedAnalog

type SysexCommandExtendedAnalog interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	SysexCommand
	// IsSysexCommandExtendedAnalog is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommandExtendedAnalog()
	// CreateBuilder creates a SysexCommandExtendedAnalogBuilder
	CreateSysexCommandExtendedAnalogBuilder() SysexCommandExtendedAnalogBuilder
}

SysexCommandExtendedAnalog is the corresponding interface of SysexCommandExtendedAnalog

func CastSysexCommandExtendedAnalog deprecated

func CastSysexCommandExtendedAnalog(structType any) SysexCommandExtendedAnalog

Deprecated: use the interface for direct cast

type SysexCommandExtendedAnalogBuilder

type SysexCommandExtendedAnalogBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() SysexCommandExtendedAnalogBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() SysexCommandBuilder
	// Build builds the SysexCommandExtendedAnalog or returns an error if something is wrong
	Build() (SysexCommandExtendedAnalog, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommandExtendedAnalog
}

SysexCommandExtendedAnalogBuilder is a builder for SysexCommandExtendedAnalog

func NewSysexCommandExtendedAnalogBuilder

func NewSysexCommandExtendedAnalogBuilder() SysexCommandExtendedAnalogBuilder

NewSysexCommandExtendedAnalogBuilder() creates a SysexCommandExtendedAnalogBuilder

type SysexCommandExtendedId

type SysexCommandExtendedId interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	SysexCommand
	// GetId returns Id (property field)
	GetId() []int8
	// IsSysexCommandExtendedId is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommandExtendedId()
	// CreateBuilder creates a SysexCommandExtendedIdBuilder
	CreateSysexCommandExtendedIdBuilder() SysexCommandExtendedIdBuilder
}

SysexCommandExtendedId is the corresponding interface of SysexCommandExtendedId

func CastSysexCommandExtendedId deprecated

func CastSysexCommandExtendedId(structType any) SysexCommandExtendedId

Deprecated: use the interface for direct cast

type SysexCommandExtendedIdBuilder

type SysexCommandExtendedIdBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(id []int8) SysexCommandExtendedIdBuilder
	// WithId adds Id (property field)
	WithId(...int8) SysexCommandExtendedIdBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() SysexCommandBuilder
	// Build builds the SysexCommandExtendedId or returns an error if something is wrong
	Build() (SysexCommandExtendedId, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommandExtendedId
}

SysexCommandExtendedIdBuilder is a builder for SysexCommandExtendedId

func NewSysexCommandExtendedIdBuilder

func NewSysexCommandExtendedIdBuilder() SysexCommandExtendedIdBuilder

NewSysexCommandExtendedIdBuilder() creates a SysexCommandExtendedIdBuilder

type SysexCommandPinStateQuery

type SysexCommandPinStateQuery interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	SysexCommand
	// GetPin returns Pin (property field)
	GetPin() uint8
	// IsSysexCommandPinStateQuery is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommandPinStateQuery()
	// CreateBuilder creates a SysexCommandPinStateQueryBuilder
	CreateSysexCommandPinStateQueryBuilder() SysexCommandPinStateQueryBuilder
}

SysexCommandPinStateQuery is the corresponding interface of SysexCommandPinStateQuery

func CastSysexCommandPinStateQuery deprecated

func CastSysexCommandPinStateQuery(structType any) SysexCommandPinStateQuery

Deprecated: use the interface for direct cast

type SysexCommandPinStateQueryBuilder

type SysexCommandPinStateQueryBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(pin uint8) SysexCommandPinStateQueryBuilder
	// WithPin adds Pin (property field)
	WithPin(uint8) SysexCommandPinStateQueryBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() SysexCommandBuilder
	// Build builds the SysexCommandPinStateQuery or returns an error if something is wrong
	Build() (SysexCommandPinStateQuery, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommandPinStateQuery
}

SysexCommandPinStateQueryBuilder is a builder for SysexCommandPinStateQuery

func NewSysexCommandPinStateQueryBuilder

func NewSysexCommandPinStateQueryBuilder() SysexCommandPinStateQueryBuilder

NewSysexCommandPinStateQueryBuilder() creates a SysexCommandPinStateQueryBuilder

type SysexCommandPinStateResponse

type SysexCommandPinStateResponse interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	SysexCommand
	// GetPin returns Pin (property field)
	GetPin() uint8
	// GetPinMode returns PinMode (property field)
	GetPinMode() uint8
	// GetPinState returns PinState (property field)
	GetPinState() uint8
	// IsSysexCommandPinStateResponse is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommandPinStateResponse()
	// CreateBuilder creates a SysexCommandPinStateResponseBuilder
	CreateSysexCommandPinStateResponseBuilder() SysexCommandPinStateResponseBuilder
}

SysexCommandPinStateResponse is the corresponding interface of SysexCommandPinStateResponse

func CastSysexCommandPinStateResponse deprecated

func CastSysexCommandPinStateResponse(structType any) SysexCommandPinStateResponse

Deprecated: use the interface for direct cast

type SysexCommandPinStateResponseBuilder

type SysexCommandPinStateResponseBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(pin uint8, pinMode uint8, pinState uint8) SysexCommandPinStateResponseBuilder
	// WithPin adds Pin (property field)
	WithPin(uint8) SysexCommandPinStateResponseBuilder
	// WithPinMode adds PinMode (property field)
	WithPinMode(uint8) SysexCommandPinStateResponseBuilder
	// WithPinState adds PinState (property field)
	WithPinState(uint8) SysexCommandPinStateResponseBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() SysexCommandBuilder
	// Build builds the SysexCommandPinStateResponse or returns an error if something is wrong
	Build() (SysexCommandPinStateResponse, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommandPinStateResponse
}

SysexCommandPinStateResponseBuilder is a builder for SysexCommandPinStateResponse

func NewSysexCommandPinStateResponseBuilder

func NewSysexCommandPinStateResponseBuilder() SysexCommandPinStateResponseBuilder

NewSysexCommandPinStateResponseBuilder() creates a SysexCommandPinStateResponseBuilder

type SysexCommandReportFirmwareRequest

type SysexCommandReportFirmwareRequest interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	SysexCommand
	// IsSysexCommandReportFirmwareRequest is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommandReportFirmwareRequest()
	// CreateBuilder creates a SysexCommandReportFirmwareRequestBuilder
	CreateSysexCommandReportFirmwareRequestBuilder() SysexCommandReportFirmwareRequestBuilder
}

SysexCommandReportFirmwareRequest is the corresponding interface of SysexCommandReportFirmwareRequest

func CastSysexCommandReportFirmwareRequest deprecated

func CastSysexCommandReportFirmwareRequest(structType any) SysexCommandReportFirmwareRequest

Deprecated: use the interface for direct cast

type SysexCommandReportFirmwareRequestBuilder

type SysexCommandReportFirmwareRequestBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() SysexCommandReportFirmwareRequestBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() SysexCommandBuilder
	// Build builds the SysexCommandReportFirmwareRequest or returns an error if something is wrong
	Build() (SysexCommandReportFirmwareRequest, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommandReportFirmwareRequest
}

SysexCommandReportFirmwareRequestBuilder is a builder for SysexCommandReportFirmwareRequest

func NewSysexCommandReportFirmwareRequestBuilder

func NewSysexCommandReportFirmwareRequestBuilder() SysexCommandReportFirmwareRequestBuilder

NewSysexCommandReportFirmwareRequestBuilder() creates a SysexCommandReportFirmwareRequestBuilder

type SysexCommandReportFirmwareResponse

type SysexCommandReportFirmwareResponse interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	SysexCommand
	// GetMajorVersion returns MajorVersion (property field)
	GetMajorVersion() uint8
	// GetMinorVersion returns MinorVersion (property field)
	GetMinorVersion() uint8
	// GetFileName returns FileName (property field)
	GetFileName() []byte
	// IsSysexCommandReportFirmwareResponse is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommandReportFirmwareResponse()
	// CreateBuilder creates a SysexCommandReportFirmwareResponseBuilder
	CreateSysexCommandReportFirmwareResponseBuilder() SysexCommandReportFirmwareResponseBuilder
}

SysexCommandReportFirmwareResponse is the corresponding interface of SysexCommandReportFirmwareResponse

func CastSysexCommandReportFirmwareResponse deprecated

func CastSysexCommandReportFirmwareResponse(structType any) SysexCommandReportFirmwareResponse

Deprecated: use the interface for direct cast

type SysexCommandReportFirmwareResponseBuilder

type SysexCommandReportFirmwareResponseBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(majorVersion uint8, minorVersion uint8, fileName []byte) SysexCommandReportFirmwareResponseBuilder
	// WithMajorVersion adds MajorVersion (property field)
	WithMajorVersion(uint8) SysexCommandReportFirmwareResponseBuilder
	// WithMinorVersion adds MinorVersion (property field)
	WithMinorVersion(uint8) SysexCommandReportFirmwareResponseBuilder
	// WithFileName adds FileName (property field)
	WithFileName(...byte) SysexCommandReportFirmwareResponseBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() SysexCommandBuilder
	// Build builds the SysexCommandReportFirmwareResponse or returns an error if something is wrong
	Build() (SysexCommandReportFirmwareResponse, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommandReportFirmwareResponse
}

SysexCommandReportFirmwareResponseBuilder is a builder for SysexCommandReportFirmwareResponse

func NewSysexCommandReportFirmwareResponseBuilder

func NewSysexCommandReportFirmwareResponseBuilder() SysexCommandReportFirmwareResponseBuilder

NewSysexCommandReportFirmwareResponseBuilder() creates a SysexCommandReportFirmwareResponseBuilder

type SysexCommandRequirements

type SysexCommandRequirements interface {
	GetLengthInBits(ctx context.Context) uint16
	GetLengthInBytes(ctx context.Context) uint16
	// GetCommandType returns CommandType (discriminator field)
	GetCommandType() uint8
	// GetResponse returns Response (discriminator field)
	GetResponse() bool
}

SysexCommandRequirements provides a set of functions which need to be implemented by a sub struct

type SysexCommandSamplingInterval

type SysexCommandSamplingInterval interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	SysexCommand
	// IsSysexCommandSamplingInterval is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommandSamplingInterval()
	// CreateBuilder creates a SysexCommandSamplingIntervalBuilder
	CreateSysexCommandSamplingIntervalBuilder() SysexCommandSamplingIntervalBuilder
}

SysexCommandSamplingInterval is the corresponding interface of SysexCommandSamplingInterval

func CastSysexCommandSamplingInterval deprecated

func CastSysexCommandSamplingInterval(structType any) SysexCommandSamplingInterval

Deprecated: use the interface for direct cast

type SysexCommandSamplingIntervalBuilder

type SysexCommandSamplingIntervalBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() SysexCommandSamplingIntervalBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() SysexCommandBuilder
	// Build builds the SysexCommandSamplingInterval or returns an error if something is wrong
	Build() (SysexCommandSamplingInterval, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommandSamplingInterval
}

SysexCommandSamplingIntervalBuilder is a builder for SysexCommandSamplingInterval

func NewSysexCommandSamplingIntervalBuilder

func NewSysexCommandSamplingIntervalBuilder() SysexCommandSamplingIntervalBuilder

NewSysexCommandSamplingIntervalBuilder() creates a SysexCommandSamplingIntervalBuilder

type SysexCommandStringData

type SysexCommandStringData interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	SysexCommand
	// IsSysexCommandStringData is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommandStringData()
	// CreateBuilder creates a SysexCommandStringDataBuilder
	CreateSysexCommandStringDataBuilder() SysexCommandStringDataBuilder
}

SysexCommandStringData is the corresponding interface of SysexCommandStringData

func CastSysexCommandStringData deprecated

func CastSysexCommandStringData(structType any) SysexCommandStringData

Deprecated: use the interface for direct cast

type SysexCommandStringDataBuilder

type SysexCommandStringDataBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() SysexCommandStringDataBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() SysexCommandBuilder
	// Build builds the SysexCommandStringData or returns an error if something is wrong
	Build() (SysexCommandStringData, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommandStringData
}

SysexCommandStringDataBuilder is a builder for SysexCommandStringData

func NewSysexCommandStringDataBuilder

func NewSysexCommandStringDataBuilder() SysexCommandStringDataBuilder

NewSysexCommandStringDataBuilder() creates a SysexCommandStringDataBuilder

type SysexCommandSysexNonRealtime

type SysexCommandSysexNonRealtime interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	SysexCommand
	// IsSysexCommandSysexNonRealtime is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommandSysexNonRealtime()
	// CreateBuilder creates a SysexCommandSysexNonRealtimeBuilder
	CreateSysexCommandSysexNonRealtimeBuilder() SysexCommandSysexNonRealtimeBuilder
}

SysexCommandSysexNonRealtime is the corresponding interface of SysexCommandSysexNonRealtime

func CastSysexCommandSysexNonRealtime deprecated

func CastSysexCommandSysexNonRealtime(structType any) SysexCommandSysexNonRealtime

Deprecated: use the interface for direct cast

type SysexCommandSysexNonRealtimeBuilder

type SysexCommandSysexNonRealtimeBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() SysexCommandSysexNonRealtimeBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() SysexCommandBuilder
	// Build builds the SysexCommandSysexNonRealtime or returns an error if something is wrong
	Build() (SysexCommandSysexNonRealtime, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommandSysexNonRealtime
}

SysexCommandSysexNonRealtimeBuilder is a builder for SysexCommandSysexNonRealtime

func NewSysexCommandSysexNonRealtimeBuilder

func NewSysexCommandSysexNonRealtimeBuilder() SysexCommandSysexNonRealtimeBuilder

NewSysexCommandSysexNonRealtimeBuilder() creates a SysexCommandSysexNonRealtimeBuilder

type SysexCommandSysexRealtime

type SysexCommandSysexRealtime interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	SysexCommand
	// IsSysexCommandSysexRealtime is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSysexCommandSysexRealtime()
	// CreateBuilder creates a SysexCommandSysexRealtimeBuilder
	CreateSysexCommandSysexRealtimeBuilder() SysexCommandSysexRealtimeBuilder
}

SysexCommandSysexRealtime is the corresponding interface of SysexCommandSysexRealtime

func CastSysexCommandSysexRealtime deprecated

func CastSysexCommandSysexRealtime(structType any) SysexCommandSysexRealtime

Deprecated: use the interface for direct cast

type SysexCommandSysexRealtimeBuilder

type SysexCommandSysexRealtimeBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() SysexCommandSysexRealtimeBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() SysexCommandBuilder
	// Build builds the SysexCommandSysexRealtime or returns an error if something is wrong
	Build() (SysexCommandSysexRealtime, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SysexCommandSysexRealtime
}

SysexCommandSysexRealtimeBuilder is a builder for SysexCommandSysexRealtime

func NewSysexCommandSysexRealtimeBuilder

func NewSysexCommandSysexRealtimeBuilder() SysexCommandSysexRealtimeBuilder

NewSysexCommandSysexRealtimeBuilder() creates a SysexCommandSysexRealtimeBuilder

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL