modulepackage
0.0.3
Repository: https://github.com/diamondburned/go-buttplug.git
Documentation: pkg.go.dev
# README
go-buttplug
A Go library for the Intiface Websocket API, which wraps the buttplug.io protocol.
Example
# Functions
CreateMessages creates a Messages object from the given messages.
NewBroadcaster creates a new broadcaster.
NewRequestServerInfo creates a new RequestServerInfo with the current client information.
NewWebsocket creates a new Buttplug Websocket client instance.
RegisterMessage registers a new message type.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Additional local-only event types.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Version is the buttplug.io schema version.
No description provided by the author
No description provided by the author
# Structs
Requests that a BatteryLevel be retreived.
Returns a BatteryLevel read from a device.
Broadcaster is used for creating multiple event loops on the same Buttplug server.
Notifies client that a device of a certain type has been added to the server.
No description provided by the author
List of all available devices known to the system.
A list of the messages a device will accept on this server implementation.
Notifies client that a device of a certain type has been removed from the server.
DialError is emitted if the Websocket fails to dial.
Signifies the server encountered an error while processing the message indicated by the id.
Sends speed and position command to the Fleshlight Launch Device denoted by the device index.
Attributes for device messages.
Message types that are expected to have an Id and nothing else.
InternalError is a pseudo-message that is sent over the event channel on background errors.
Sends a raw byte string to a Kiiroo Onyx/Pearl device.
Sends a linear movement command to a device that supports linear movements.
Log message from the server.
Sends a command string to a Lovense device.
Attributes for device message that have no attributes.
Signifies successful processing of the message indicated by the id.
Connection keep-alive message.
Attributes for raw device messages.
Request a raw byte array from a device.
Raw byte array received from a device.
Subscribe to an endpoint on a device to receive raw info back.
Unsubscribe to an endpoint on a device.
Sends a raw byte array to a device.
Request for the server to send a list of devices to the client.
Request for server to stream log messages of a certain level to client.
Request server version, and relay client name.
Sends a rotate command to a device that supports rotation.
Requests that a RSSI level be retreived.
Returns a BatteryLevel read from a device.
Server notification to client that scanning has ended.
Server version information, in Major.Minor.Build format.
Sends a vibrate command to a device that supports vibration.
Request for the server to start scanning for new devices.
Stops all actions currently being taken by all connected devices.
Stops the all actions currently being taken by a device.
Request for the server to stop scanning for new devices.
Message sent by the server that is not in direct reply to a message send from the client, and always uses system Id.
Used for connection/application testing.
UnknownEventError is an error that's sent on an unknown event.
VersionMismatchError is returned if the server's version does not match the client's.
Sends a vibrate command to a device that supports vibration.
Sends a raw byte string to a Kiiroo Onyx/Pearl device.
Websocket describes a websocket connection to the Buttplug server.
# Interfaces
Message is an interface ethat all messages will satisfy.
# Type aliases
Index used for referencing the device in device messages.
A list of the messages a device will accept on this server implementation.
Name of the device.
Number of features on device.
User-set id for the message.
Messages is the large messages object that's passed around.
MessageType identifies a message type in a Messages object.
Specifies granularity of each feature on the device.
Used for non-direct-reply messages that can only be sent from server to client, using the reserved system message Id of 0.