# 3.0.3 (2021-04-24)
## Bugfixes
- Fix RawWriteCmd JSON schema to handle WriteWithResponse field
# 3.0.2 (2021-04-22)
## Bugfixes
- Device Config File update to fix a crash in MagicMotion v2 and v3 battery queries.
# 3.0.1 (2021-04-18)
## Bugfixes
- #313: Fix reading of lovense battery status when device is running
- Don't try to compile native-tls when not using websockets feature
# 3.0.0 (2021-04-11)
## Features
- Added hardware support:
- Lovelife (OhMiBod) Lumen
- Mysteryvibe Poco
- Libo Selina
- #311: Reduce runtime support to simplify library
- Added tokio runtime support
- Needed for Unity support of buttplug-rs.
- Removed async-std runtime support
- We don't really have the resources to keep supporting multiple runtimes, and async-std has
tokio compat.
- Removed futures::ThreadPool runtime support
- This was easy to support when the library started, but seems silly now.
- #310: Removed Secure Sockets as on option on Websocket Servers
- Our original reason for implementing this was for browsers that didn't handle connecting to
mixed content (i.e. https website connecting via websockets to http localhost). Firefox resolved
this a few months ago, and Chrome and Edge both support it too. Safari has always been a weird
mess, so we don't really care there. If users still need this functionality, they can set up their own reverse proxy, but this frees us from having to support this for them, which took a ton of code and time.
- Added more logging, now using fields to track device lifetimes across log contexts
- #312: Added more Drop implementations to make clean shutdown happen properly
## Bugfixes
- #295: Prettylove devices require WriteWithResponse to control properly.
## Breaking Changes
- ButtplugWebsocketServerConnectorOptions no longer has secure options, and the insecure port option
is now mandatory.
- Removed build features for no longer supported runtimes, native programs using Buttplug as an
executable will need to spin up a tokio runtime, either via the tokio::main macro or manually.
# 2.1.9 (2021-04-04)
## Bugfixes
- #305: Updated btleplug to not panic on read/write failures on Windows UWP, which may fix some
issues with bluetooth disconnections.
- #302: Lovense devices no longer stall forever when device disconnects while reading battery
- #300: Error logs changed to warn when bluetooth dongle not present
- #299: Lovense dongle state machine now handles more state/status transfers, resulting in less
error messages.
# 2.1.8 (2021-03-25)
## Bugfixes
- #296: Fix issue with bluetooth devices not registering disconnects correctly on some instances in
windows.
# 2.1.7 (2021-03-08)
## Features
- Added LoveHoney Desire Egg hardware support
- Handy now supports FleshlightLaunchFW12Cmd when using <= v1 of the protocol, meaning it will work
with ScriptPlayer and Syncydink
- Vorze now supports VorzeA10CycloneCmd when using <= v1 of the protocol, meaning it will work with
ScriptPlayer and Syncydink
# Bugfixes
- #281: Split the Kiiroo v2.1 protocols into toys that require init, versus those that don't.
# 2.1.6 (2021-02-28)
## Features
- Update to btleplug v0.7
- Mostly bugfixes and cleanup
- Add device support for the Lovehoney Desire Love Egg
## Bugfixes
- Remove info level message that fires on every btle characteristic notification.
# 2.1.5 (2021-02-20)
## Bugfixes
- #283: Fix timing to connection status update in Client, reducing the possibility of races with the
server handshake.
- #284: Fix issue where devices can cause panics if they disconnect in
ButtplugProtocol::initialize()
# 2.1.4 (2021-02-13)
## Features
- Additional Hardware Support
- The Handy
## Bugfixes
- #280 - Lovense Serial Dongle had some timing issues that caused a thread panic
- #277 - Add retry loop for communicating with LoveAi Dolp and other toys
# 2.1.3 (2021-02-10)
## Bugfixes
- #279: Allow device command arguments to be set to 1.0 without trigger validation errors.
# 2.1.2 (2021-02-07)
## Bugfixes
- #276: Fix StopAllDevices default id so it will still send in in-process situations.
# 2.1.1 (2021-02-06)
## Bugfixes
- Fix compilation issue with btleplug in Linux and on CI
- Fix device enumeration example to use all comm managers by default
# 2.1.0 (2021-02-04)
## Features
- Hardware Support
- Nobra's Silicone Dreams (All bluetooth 2/RFCOMM controllable toys)
- Lovense Diamo
- Add message validation
- We were only checking messages via the JSON schema, which wasn't handling a lot of invalid
content. Things should now throw more useful errors on invalid content.
- Outside of message ids, messages are now immutable, meaning we don't have to check validity
multiple times.
- Clean up connector and transport code
- Fix a lot of weird return types and trait bounds.
- Add more tests, as well as testing capabilities
- Thanks to the connector/transport cleanup we can now test connectors and serializers easier.
- Consolidate support repos into main repo
- buttplug-rs now has both device config and schema repos in it.
## Bugfixes
- #265: Drop devices that are connecting when there is no device manager
# 2.0.6 (2021-01-26)
## Bugfixes
- #261: Fix crates URL in README
- #262: Client device status nows updates to disconnected on client disconnect
- #263: Client now clears held devices on disconnect
- #264: System no longer panics on client events when client event stream has no listeners
# 2.0.5 (2021-01-24)
## Bugfixes
- #260: original_device_messages shouldn't be deserialized.
- Put the wrong decorator on the field. :(
# 2.0.4 (2021-01-24)
## Bugfixes
- #258: XInput devices no longer cause panic on discovery due to address/identifier mismatches
- #259: Make sure futures-timer works with WASM
- Also fixes #253 (Onyx+ issues) because I can readd the init delay between packets for WASM
# 2.0.3 (2021-01-21)
## Bugfixes
- #256: Constrain device message types available in clients
- Clients shouldn't have to deal with deprecated messages, but sometimes the server will send them
in attributes (See #257). Constraint the available messages to those currently live in the spec.
Only really affects FFI libraries.
# 2.0.2 (2021-01-18)
## Bugfixes
- Fix (another) issue with Lovense dongle device scanning not handling state updates correctly.
# 2.0.1 (2021-01-18)
## Bugfixes
- Update to btleplug 0.5.5, fixing issue with async-std channel API versioning
- Fix issue where not having a Lovense Dongle causes the device scanning system to hang forever
# 2.0.0 (2021-01-18)
## Features
- #202, #227, #228, #246: Rebuild the event and channel systems using tokio channels
- Switched from using async-channel and the broadcaster crate to tokio's sync module, which has a
far more ergonomic channel system. Greatly reduces chances of leaking channels.
- Massively changes how the surface API looks, hence rolling major versions.
- Restructed DeviceImpl objects to reduce boilerplate and centralize check logic.
- Restructed internal event loops to be slightly less messy.
- Added device support
- Lovense Ferri
## Bugfixes
- #254: Fix issue with devices connected to Lovense Dongle not being picked up on startup
- #250: Websocket server no longer crashes when started without ports
# 1.0.5 (2021-01-09)
## Features
- #242: Added Libo support
## Bugfixes
- #244: Prettylove protocol handling now uses command caching, fixed name lookup
- #245: Fix device configuration for Virtual Rabbit
# 1.0.4 (2021-01-02)
## Features
- #238: XInput gamepads now fire Disconnection events, which should stop devices from being
double-added.
# 1.0.3 (2021-01-01)
## Features
- #235: XInput now rescans every 1 second until told to stop (versus scanning once and never
scanning until StartScanning is called again.)
- #231: Use LTO in release builds
## Bugfixes
- #236: Bluetooth device scanning no longer ignores addresses without names in advertisements. Fixes
issues where RSSI updates were received before advertisements.
- #234: Fix declaration of Send/Sync on ButtplugFutureSharedState
# 1.0.2 (2020-12-31)
## Bugfixes
- Fix race condition that caused ScanningFinished to be fired before some managers may have finished
scanning.
- Fix a bunch of intermittent test issues that were plaguing CI.
# 1.0.1 (2020-12-27)
## Bugfixes
- Roll back Valico dependency to 3.4.0. 3.5.0 brings in a ton of extremely old and unmaintained
libraries, some of which break WASM.
# 1.0.0 (2020-12-27)
## API Changes
- Return futures::Stream instead of futures::StreamExt for event streams
- Add device config file version loading
# 0.11.3 (2020-12-22)
## Bugfixes
- Fixed memory/task leak and CPU spikes when start scanning was called often. (#226)
- Fixed possible race due to lack of trait bounds on future types (#225)
# 0.11.2 (2020-12-12)
## Bugfixes
- Client now emits ServerDisconnect when server disconnects.
- Client and Server now emit ScanningFinished when all scanning has stopped.
- Adjust Send trait requirements for async spawned tasks from the WASM manager.
- Remove unused WASM bindings.
# 0.11.1 (2020-11-26)
## API Changes
- Add hardware support
- Mysteryvibe (all products)
- Implement device disconnect in buttplug-rs client
- Implement manual ping in buttplug-rs client
## Bugfixes
- Remove Default trait implementations for device messages
- They always need device IDs and shouldn't be default constructable.
- Fixes StopDeviceCmd issues in buttplug-rs client
# 0.11.0 (2020-10-31)
## API Changes
- ButtplugClientDevice now sent with ButtplugClientEvent::DeviceRemoved event
- Used to just send the index, but that's annoying for the user.
- More WASM type exposure.
# 0.10.1 (2020-10-24)
## Bugfixes
- Devices now keep their indexes for the life of the process, based on device
address.
- Fixed a lot of Lovense Dongle bugs
- Devices now register disconnects
- Dongle now emits scanning finished events
- Dongle now handles being unplugged (but not replugged yet)
- Removed .unwrap()s in BTLEPlug that were causing crashes.
## API Changes
- Exposed Endpoint enum to WASM when doing wasm runtime builds
# 0.10.0 (2020-10-17)
## Features
- New Device Support
- Kiiroo Keon
- Added Raw commands, which allows direct read/write access to devices.
- Must be explicitly turned on during server creation
- Devices will have "(Raw)" appended to their display names to let users know
raw commands are active.
- Added 32 generic endpoints
- Needed for Raw message setup
- Added stop_all_devices to client API
## Bugfixes
- Websocket Server no longer panics on bogus connect (TLS on non-TLS port, vice
versa, browser hasn't accepted cert, etc...)
- Server now stops scanning when a client disconnects
## API Changes
- Removed RequestLog/Log access in API, as those messages were deprecated in v2
of the message spec.
- Older apps will just receive an error when RequestLog is sent.
- Creating a server now takes a Server Options struct argument.
- All methods of creating servers (directly, ButtplugRemoteServer, servers in
InProcessConnectors) have been updated to this format.
- DeviceConfigurationManager no longer static
- Makes it easier to configure for Raw Messages, and is also just a better
architecture in general.
- Fallible/non-Self-returning new() methods no longer called new()
- Idiomatic rust requires infallible new() -> Self, and a lot of our
constructors are fallible and sometimes return tuples.
- Removed ButtplugProtocolCreator
- Was needed when we were using async_trait due to associated trait methods,
now just bound on Self: Sized.
# 0.9.2 (2020-10-06)
## Bugfixes
- Update to btleplug 0.5.4, fixing a bug with trying to read from bluetooth
devices on macOS.
# 0.9.1 (2020-10-05)
## Bugfixes
- Update to btleplug 0.5.3, fixing a bug with trying to write to bluetooth
devices on macOS.
# 0.9.0 (2020-10-04)
## Features
- Implements BatteryLevelCmd/BatteryLevelReading
- Can read battery values from Lovense and some MagicMotion devices.
## Bugfixes
- Devices now only pay attention to their events, not all events ever.
- Devices were mistaking other devices disconnecting for their own
disconnection, causing tons of issues in 2+ device situations.
# 0.8.4 (2020-10-01)
## Features
- Added more Lovense UUIDs
- Should work with Ambi now? Maybe?
- Might work with Lovense Mission
- Add wasm-bindgen async manager (Needed for WASM FFI)
- Implement read capabilties for btleplug comm manager devices
## Bugfixes
- Fixed LeloF1s bringup
- Fixed Onyx+ connection creation (requires pairing with OS)
- Fixed WeVibe initial connection (now vibrates on pair)
- EventReceiver is now StreamExt instead of SinkExt (fixed for FFI)
- Fix device message enum ordering (needed for test verifications)
- Make sure we send StopDeviceCmd in device attributes
- Fix issues with Youou and wildcard name lookups
# 0.8.3 (2020-09-20)
## Features
- Add wasm-bindgen executor to async-manager
- Add serializer type default to RemoteClientConnector type to simplify
definitions.
## Bugfixes
- Expose Connector building traits to public API surface
- Add FleshlightLaunchFW12 message capabilities to device config
# 0.8.2 (2020-09-13)
## Bugfixes
- Fix default feature list in Cargo that got changed while testing 0.8.1 :(
# 0.8.1 (2020-09-13)
## Bugfixes
- Fix compile issues missed due to feature build failure
- Need to get feature building into CI. :(
# 0.8.0 (2020-09-13)
## Features
- Simplified logging, adding a channel output filter while removing
request_log/log client access for the moment.
- Minor version update due to public facing API surface change.
- Not particularly sure about the future of logging in the Buttplug Protocol,
as it's both a security risk and difficult to work with. It seems like it
might be better to expunge logging from the protocol and just deal with it
at the library/app level. See
https://github.com/buttplugio/buttplug-rs/issues/131 for more discussion.
## Bugfixes
- Lovense rotation for Nora works again
- Websocket Server should stop panicing on unwrap when connection is not severed
gracefully (#153)
# 0.7.3 (2020-09-11)
## Bugfixes
- Allow for loading either PKCS8 or RSA private keys in websocket secure server
impl
# 0.7.2 (2020-09-07)
## Features
- Merge device configuration changes from mainline device config
- Should fix up some issues with Lovense devices not appearing.
## Bugfixes
- Websockets now actually listen on all interfaces when option is passed.
# 0.7.1 (2020-09-06)
## Bugfixes
- Fix documentation location so docs.rs doesn't get mad about missing docs.
# 0.7.0 (2020-09-06)
## Features
- Added device support:
- Kiiroo v2 (Onyx 2/Launch), v2.1 (Onyx+/Cliona/Titan/Blowbot/Pearl 2/Pearl 2.1 etc)
- Vibratissimo (all products)
- Motorbunny
- WeVibe
- Magic Motion
- Expose device index on client devices for FFI usage
- Have remote server emit events for Intiface CLI
## Bugfixes
- Fix LinearCmd JSON schema
- Fix mismatched stepcounts for some devices in device config
- Make device command rounding use ceiling, mirroring output of
buttplug-js/buttplug-csharp
# 0.6.0 (2020-08-03)
## Features
- Add websocket server transport, allowing a buttplug client/server to sit
behind either a websocket client or server.
- Add Remote Server class, allowing a buttplug server to be wrapped in a
serializer and transport for remote use (i.e. over websockets, tcp, etc), as
well as being reused between connections.
## Bugfixes
- Fix names of Lovense Dongle managers so they don't write over each other.
- Fix checking of comm managers being added so two managers of the same
name/type can't be added.
- Lovense HID Dongle manager no longer panics if it can't find a dongle.
- Import README as top level doc
- Fix library building with feature variations (i.e. no features, client only,
server only, etc)
## Maintenance
- Change feature names to all be kebab-case, and to follow certain standards
(i.e. all comm manager features end in "-manager")
# 0.5.0 (2020-07-26)
## Features
- Error system now uses thiserror
- Should be more consistent and provide more useful errors. I hope. Maybe.
- Serial port support added
- No protocols using this yet, TCode/ET312/etc coming in point releases.
- Lovense dongle support added
- Handles both serial and HID versions of the dongle, on all desktop
platforms.
## Bugfixes
- Bluetooth Device Disconnections now notify on all native platforms
- Used to be just linux, now fixed for mac/win also
- Stopping scanning twice no longer panics
- Fix start scanning timing to happen when future is await'd
- This could cause discovery race conditions in the past
# 0.4.0 (2020-06-21)
## Features
- Logging now handled via tracing.
- More work needed to get all futures instrumented and what not, but we're on
the way.
- Connector module created, ungluing connectors from the Client API and making
them Client/Server agnostic. Wrappers from 0.3.0 merged into the connector
implementation.
- Server connectors on the way in an upcoming version.
- Abstract serializers into connector module
- Serializers were split cross Client and Server implementations. Like
connectors, they are now agnostic to Client/Server usage.
- Abstract runtime management to async_manager
- Idea taken from https://github.com/najamelan/async_executors, but had some
different requirements. May switch to that at some point though.
- Add more documentation for Client and Connector modules
- Simplify event loops some
- The internal event loops were becoming a rats nest of channels, select!'s
and match blocks. They're still not great, but they're better than they
were.
- Move to dashmap for internal concurrent Hashmaps
- Tried evmap, but don't need multi-valued maps. Dashmap is a good
intermediary between evmap and Arc<Mutex<Hashmap<T>>>
- Implement RawRead/Write/Subscribe/Unsubscribe
- More Buttplug v2 message spec messages. Still not currently exposed on
devices as we need it to be an opt-in feature.
## Bugfixes
- Clarify names of messages structs
- ButtplugIn/OutMessage, while hilariously on-brand for the project, didn't
provide enough context in code. Renamed to ButtplugClient/ServerMessage,
which denotes the originating source of the message (since Clients and
Servers will never send the same message types).
- Async functions now actually async.
- In earlier versions, most async methods took &mut self, meaning we were not
async since usage of a struct would be locked while the future executed. As
of 0.4.0, most if not all exposed methods take &self and return a future,
meaning the library mostly works through lazy execution now.
- Protocols are no longer opaque macro structures
- Went a little overboard on macros with protocols, meaning it was extremely
difficult to tell what code was being generated, and it made debugging a
nightmare. Protocols are now just structs with certain derivable traits with
default impls, meaning functionality can be implemented in overrides which
keeps the code clean and mostly free of boilerplate.
- Fixed race condition bug on device creation
- We fired connection events before storing off the device, meaning depending
on task scheduling clients could access devices they just got in DeviceAdded
messages, that would then report as not found.
# 0.3.1 (2020-05-13)
## Bugfixes
- Error instead of panic on btleplug connection failure
- Explain issues with scanning failures in error message
# 0.3.0 (2020-05-10)
## Features
- Servers can now be extracted from wrappers, meaning they can be
saved and reused between connections. This allows us to implement
the --stayopen argument in intiface-cli.
## Bugfixes
- Make tests broken in 0.2.4 actually pass again.
# 0.2.4 (2020-05-09)
## Bugfixes
- Fixed issue with ServerInfo not returning proper matching message ID
when communicating with clients of older spec versions
- Fixed issue with in-process server wrappers not setting message ID
on return
# 0.2.3 (2020-04-18)
## Features
- ButtplugServerJSONWrapper can now use injected servers instead of always
creating the server itself
## Bugfixes
- Fix global device config string types
- Update to btleplug 0.4.2, which no longer prints to console on windows
- XInput no longer prints everything to console
# 0.2.2 (2020-04-15)
## Features
- XInput is now a default feature
- This needed to happen in order to make things like intiface-cli
easier to build. Doesn't affect any non-windows platforms, as
everything if cfg'd out.
# 0.2.1 (2020-04-14)
## Bugfixes
- Update the README. Really. That's it. I just forgot. :(
# 0.2.0 (2020-04-12)
## Features
- Added XInput support on windows
- Added TestDeviceCommunicationManager and devices for testing/examples.
- Add RequestLog/Log handling in server.
- Create Server Wrappers concept, for handling message conversion into/out of
the server. Includes JSON implementation.
- Make Server backward compatible to connections from all older message spec
versions (using server wrappers), along with ability to do message
up/downgrades (i.e. VibrateCmd <-> SingleMotorVibrateCmd for spec 0/1)
- Add JSON schema verification of device config files and incoming messages on
client/server
- Add simple user configuration loading, so users can specify serial ports once
we support them
## Bugfixes
- Ping timeouts now actually stop devices
## Other
- Divided out message classes into their own files
- Broke ButtplugMessageUnion into smaller message unions, so we can do less type
checking manually.
# 0.1.0 (2020-02-15)
## Features
- Added server, with Win/Linux/macOS/iOS access to Bluetooth
- Added device support for the following brands:
- Lovense
- Picobong
- Aneros
- Lovehoney
- MaxPro
- PrettyLove
- Realov
- Svakom
- Vorze
- YouCups
- Youou
- Server not yet feature complete, missing functionality present in
C#/Typescript servers. This is an intermediate release to allow
testing of the server code while work on features and parity with
other versions continues.
# v0.0.2 - 2019/11/21
## Features
- Overhauled API, now have an event loop that the client is created in
and lives in.
- Finished full implementation of Client.
- Added features for partial library builds.
- Integrated websocket connector into library.
- More documentation.
# v0.0.2-beta.1 - 2019/11/03
## Features
- Lots of documentation.
- Continue cleaning up experimental implementation.
- Readd server tests.
## Bugfixes
- Connector failure now fails all the way up through the client
instance.
# v0.0.2-beta.0 - 2019/11/02
## Features
- First version of the new rust rewrite. Uses async/await and Rust
1.39 heavily.
- Partial client implementation.
# v0.0.1 - 2019/04/18
## Features
- Squatting the name on crates.io because I am horrible.
# v0.0.0 - 2016/10/01
- The original try at building Buttplug in Rust. At the time, tokio
had just come out, and futures were just becoming a thing. A
combination of those problems combined with lack of Bluetooth access
support (which wouldn't even be possible on Windows 10 until April
2017) meant this version fizzled out pretty quick.