Skip to content

feat: Add support for Syncbot #694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: dev
Choose a base branch
from
Draft

feat: Add support for Syncbot #694

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1773a96
feat: Add support for Syncbot
AshyHacker Mar 15, 2025
c0ec871
feat: Add test cases for Syncbot protocol
AshyHacker Mar 15, 2025
5441f46
Apply review fixes
AshyHacker Mar 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions buttplug/buttplug-device-config/build-config/buttplug-device-config-v3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18686,6 +18686,63 @@
}
}
]
},
"syncbot": {
"defaults": {
"name": "Syncbot",
"features": [
{
"feature-type": "Rotate",
"actuator": {
"step-range": [
0,
127
],
"messages": [
"RotateCmd"
]
}
},
{
"feature-type": "Constrict",
"actuator": {
"step-range": [
0,
88
],
"messages": [
"ScalarCmd"
]
}
},
{
"feature-type": "Position",
"actuator": {
"step-range": [
0,
255
],
"messages": [
"LinearCmd"
]
}
}
]
},
"communication": [
{
"btle": {
"names": [
"V"
],
"services": {
"0000ffe0-0000-1000-8000-00805f9b34fb": {
"tx": "0000ffe1-0000-1000-8000-00805f9b34fb"
}
}
}
}
]
}
}
}
34 changes: 33 additions & 1 deletion buttplug/buttplug-device-config/device-config-v3/buttplug-device-config-v3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10711,4 +10711,36 @@ protocols:
- S6
services:
0000ffb0-0000-1000-8000-00805f9b34fb:
tx: 0000ffb2-0000-1000-8000-00805f9b34fb
tx: 0000ffb2-0000-1000-8000-00805f9b34fb
syncbot:
defaults:
name: Syncbot
features:
- feature-type: Rotate
actuator:
step-range:
- 0
- 127
messages:
- RotateCmd
- feature-type: Constrict
actuator:
step-range:
- 0
- 88
messages:
- ScalarCmd
- feature-type: Position
actuator:
step-range:
- 0
- 255
messages:
- LinearCmd
communication:
- btle:
names:
- V
services:
0000ffe0-0000-1000-8000-00805f9b34fb:
tx: 0000ffe1-0000-1000-8000-00805f9b34fb
Copy link
Collaborator

@blackspherefollower blackspherefollower Mar 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't suppose you did any work to understand the touch slider readings?

Copy link
Author

@AshyHacker AshyHacker Mar 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right. Syncbot also has Rx channel and can read battery level and slider, but this PR focuses on the core functionality. (This is just FYI question, right?)

Copy link
Collaborator

@blackspherefollower blackspherefollower Mar 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty much. Ideally I'd ask for the protocol to be documented (both directions) in an issue on https://github.com/buttplugio/docs.buttplug.io just so we at least have the notes recorded so it'll be quicker to add sensor support later

Copy link
Author

@AshyHacker AshyHacker Mar 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. I have summarized the findings from my analysis in an issue.

buttplugio/docs.buttplug.io#42

5 changes: 5 additions & 0 deletions buttplug/src/server/device/protocol/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ pub mod svakom_v3;
pub mod svakom_v4;
pub mod svakom_v5;
pub mod svakom_v6;
pub mod syncbot;
pub mod synchro;
pub mod tcode_v03;
pub mod thehandy;
Expand Down Expand Up @@ -608,6 +609,10 @@ pub fn get_default_protocol_map() -> HashMap<String, Arc<dyn ProtocolIdentifierF
&mut map,
svakom_v6::setup::SvakomV6IdentifierFactory::default(),
);
add_to_protocol_map(
&mut map,
syncbot::setup::SyncbotIdentifierFactory::default(),
);
add_to_protocol_map(
&mut map,
synchro::setup::SynchroIdentifierFactory::default(),
Expand Down
Loading