pub struct StudioClient<T> { /* private fields */ }Expand description
Errors returned by high-level client operations. High-level synchronous ZMK Studio RPC client.
The generic parameter T is any transport implementing Read + Write
(for example crate::transport::serial::SerialTransport).
Implementations§
Source§impl<T: Read + Write> StudioClient<T>
impl<T: Read + Write> StudioClient<T>
Sourcepub fn new(io: T) -> Self
pub fn new(io: T) -> Self
Examples found in repository?
21fn run() -> Result<(), Box<dyn Error>> {
22 let mut args = std::env::args().skip(1);
23 let Some(mode) = args.next() else {
24 print_usage();
25 return Ok(());
26 };
27
28 match mode.as_str() {
29 "serial" => {
30 #[cfg(feature = "serial")]
31 {
32 let Some(port) = args.next() else {
33 print_usage();
34 return Ok(());
35 };
36 let client = StudioClient::new(SerialTransport::open(&port)?);
37 run_example(client)
38 }
39 #[cfg(not(feature = "serial"))]
40 {
41 Err("built without `serial` feature".into())
42 }
43 }
44 "ble" => {
45 #[cfg(feature = "ble")]
46 {
47 let _name_substring = args.next();
48 let client = StudioClient::new(BleTransport::connect_first()?);
49 run_example(client)
50 }
51 #[cfg(not(feature = "ble"))]
52 {
53 Err("built without `ble` feature".into())
54 }
55 }
56 _ => {
57 print_usage();
58 Ok(())
59 }
60 }
61}Sourcepub fn next_notification(&mut self) -> Option<Notification>
pub fn next_notification(&mut self) -> Option<Notification>
Returns the next queued notification, if any.
Sourcepub fn read_notification_blocking(
&mut self,
) -> Result<Notification, ClientError>
pub fn read_notification_blocking( &mut self, ) -> Result<Notification, ClientError>
Blocks until a notification arrives and returns it.
Sourcepub fn get_device_info(&mut self) -> Result<GetDeviceInfoResponse, ClientError>
pub fn get_device_info(&mut self) -> Result<GetDeviceInfoResponse, ClientError>
Returns static device information.
Examples found in repository?
63fn run_example<T: Read + Write>(mut client: StudioClient<T>) -> Result<(), Box<dyn Error>> {
64 let info = client.get_device_info()?;
65 println!("Device: {}", info.name);
66 println!("Lock: {:?}", client.get_lock_state()?);
67
68 let behavior_ids = client.list_all_behaviors()?;
69 println!("Behavior count: {}", behavior_ids.len());
70 if let Some(first_behavior_id) = behavior_ids.first().copied() {
71 let details = client.get_behavior_details(first_behavior_id)?;
72 println!("First behavior: {} ({})", details.id, details.display_name);
73 }
74
75 let keymap = match client.get_keymap() {
76 Ok(keymap) => keymap,
77 Err(ClientError::Meta(_)) => {
78 println!("Keymap request denied (likely locked); press `&studio_unlock` then rerun.");
79 return Ok(());
80 }
81 Err(err) => return Err(Box::new(err)),
82 };
83 println!("Layers: {}", keymap.layers.len());
84
85 let layouts = client.get_physical_layouts()?;
86 println!(
87 "Physical layouts: {} (active index: {})",
88 layouts.layouts.len(),
89 layouts.active_layout_index
90 );
91
92 let Some(first_layer) = keymap.layers.first() else {
93 return Ok(());
94 };
95 if first_layer.bindings.is_empty() {
96 return Ok(());
97 }
98
99 let layer_id = first_layer.id;
100 let key_position = 0;
101
102 let before = client.get_key_at(layer_id, key_position)?;
103 println!("Before: {before:?}");
104
105 client.set_key_at(
106 layer_id,
107 key_position,
108 Behavior::KeyPress(HidUsage::from_encoded(Keycode::A.to_hid_usage())),
109 )?;
110 let after = client.get_key_at(layer_id, key_position)?;
111 println!("After: {after:?}");
112
113 // Change management APIs.
114 let has_changes = client.check_unsaved_changes()?;
115 println!("Unsaved changes: {has_changes}");
116 if has_changes {
117 client.discard_changes()?;
118 }
119
120 Ok(())
121}Sourcepub fn get_lock_state(&mut self) -> Result<LockState, ClientError>
pub fn get_lock_state(&mut self) -> Result<LockState, ClientError>
Returns the current Studio lock state.
Examples found in repository?
63fn run_example<T: Read + Write>(mut client: StudioClient<T>) -> Result<(), Box<dyn Error>> {
64 let info = client.get_device_info()?;
65 println!("Device: {}", info.name);
66 println!("Lock: {:?}", client.get_lock_state()?);
67
68 let behavior_ids = client.list_all_behaviors()?;
69 println!("Behavior count: {}", behavior_ids.len());
70 if let Some(first_behavior_id) = behavior_ids.first().copied() {
71 let details = client.get_behavior_details(first_behavior_id)?;
72 println!("First behavior: {} ({})", details.id, details.display_name);
73 }
74
75 let keymap = match client.get_keymap() {
76 Ok(keymap) => keymap,
77 Err(ClientError::Meta(_)) => {
78 println!("Keymap request denied (likely locked); press `&studio_unlock` then rerun.");
79 return Ok(());
80 }
81 Err(err) => return Err(Box::new(err)),
82 };
83 println!("Layers: {}", keymap.layers.len());
84
85 let layouts = client.get_physical_layouts()?;
86 println!(
87 "Physical layouts: {} (active index: {})",
88 layouts.layouts.len(),
89 layouts.active_layout_index
90 );
91
92 let Some(first_layer) = keymap.layers.first() else {
93 return Ok(());
94 };
95 if first_layer.bindings.is_empty() {
96 return Ok(());
97 }
98
99 let layer_id = first_layer.id;
100 let key_position = 0;
101
102 let before = client.get_key_at(layer_id, key_position)?;
103 println!("Before: {before:?}");
104
105 client.set_key_at(
106 layer_id,
107 key_position,
108 Behavior::KeyPress(HidUsage::from_encoded(Keycode::A.to_hid_usage())),
109 )?;
110 let after = client.get_key_at(layer_id, key_position)?;
111 println!("After: {after:?}");
112
113 // Change management APIs.
114 let has_changes = client.check_unsaved_changes()?;
115 println!("Unsaved changes: {has_changes}");
116 if has_changes {
117 client.discard_changes()?;
118 }
119
120 Ok(())
121}Sourcepub fn reset_settings(&mut self) -> Result<bool, ClientError>
pub fn reset_settings(&mut self) -> Result<bool, ClientError>
Resets settings on the device.
Returns the firmware-provided success boolean.
Sourcepub fn list_all_behaviors(&mut self) -> Result<Vec<u32>, ClientError>
pub fn list_all_behaviors(&mut self) -> Result<Vec<u32>, ClientError>
Lists behavior IDs available on the connected device.
Examples found in repository?
63fn run_example<T: Read + Write>(mut client: StudioClient<T>) -> Result<(), Box<dyn Error>> {
64 let info = client.get_device_info()?;
65 println!("Device: {}", info.name);
66 println!("Lock: {:?}", client.get_lock_state()?);
67
68 let behavior_ids = client.list_all_behaviors()?;
69 println!("Behavior count: {}", behavior_ids.len());
70 if let Some(first_behavior_id) = behavior_ids.first().copied() {
71 let details = client.get_behavior_details(first_behavior_id)?;
72 println!("First behavior: {} ({})", details.id, details.display_name);
73 }
74
75 let keymap = match client.get_keymap() {
76 Ok(keymap) => keymap,
77 Err(ClientError::Meta(_)) => {
78 println!("Keymap request denied (likely locked); press `&studio_unlock` then rerun.");
79 return Ok(());
80 }
81 Err(err) => return Err(Box::new(err)),
82 };
83 println!("Layers: {}", keymap.layers.len());
84
85 let layouts = client.get_physical_layouts()?;
86 println!(
87 "Physical layouts: {} (active index: {})",
88 layouts.layouts.len(),
89 layouts.active_layout_index
90 );
91
92 let Some(first_layer) = keymap.layers.first() else {
93 return Ok(());
94 };
95 if first_layer.bindings.is_empty() {
96 return Ok(());
97 }
98
99 let layer_id = first_layer.id;
100 let key_position = 0;
101
102 let before = client.get_key_at(layer_id, key_position)?;
103 println!("Before: {before:?}");
104
105 client.set_key_at(
106 layer_id,
107 key_position,
108 Behavior::KeyPress(HidUsage::from_encoded(Keycode::A.to_hid_usage())),
109 )?;
110 let after = client.get_key_at(layer_id, key_position)?;
111 println!("After: {after:?}");
112
113 // Change management APIs.
114 let has_changes = client.check_unsaved_changes()?;
115 println!("Unsaved changes: {has_changes}");
116 if has_changes {
117 client.discard_changes()?;
118 }
119
120 Ok(())
121}Sourcepub fn get_behavior_details(
&mut self,
behavior_id: u32,
) -> Result<GetBehaviorDetailsResponse, ClientError>
pub fn get_behavior_details( &mut self, behavior_id: u32, ) -> Result<GetBehaviorDetailsResponse, ClientError>
Returns details for a behavior ID (name and parameter metadata).
Examples found in repository?
63fn run_example<T: Read + Write>(mut client: StudioClient<T>) -> Result<(), Box<dyn Error>> {
64 let info = client.get_device_info()?;
65 println!("Device: {}", info.name);
66 println!("Lock: {:?}", client.get_lock_state()?);
67
68 let behavior_ids = client.list_all_behaviors()?;
69 println!("Behavior count: {}", behavior_ids.len());
70 if let Some(first_behavior_id) = behavior_ids.first().copied() {
71 let details = client.get_behavior_details(first_behavior_id)?;
72 println!("First behavior: {} ({})", details.id, details.display_name);
73 }
74
75 let keymap = match client.get_keymap() {
76 Ok(keymap) => keymap,
77 Err(ClientError::Meta(_)) => {
78 println!("Keymap request denied (likely locked); press `&studio_unlock` then rerun.");
79 return Ok(());
80 }
81 Err(err) => return Err(Box::new(err)),
82 };
83 println!("Layers: {}", keymap.layers.len());
84
85 let layouts = client.get_physical_layouts()?;
86 println!(
87 "Physical layouts: {} (active index: {})",
88 layouts.layouts.len(),
89 layouts.active_layout_index
90 );
91
92 let Some(first_layer) = keymap.layers.first() else {
93 return Ok(());
94 };
95 if first_layer.bindings.is_empty() {
96 return Ok(());
97 }
98
99 let layer_id = first_layer.id;
100 let key_position = 0;
101
102 let before = client.get_key_at(layer_id, key_position)?;
103 println!("Before: {before:?}");
104
105 client.set_key_at(
106 layer_id,
107 key_position,
108 Behavior::KeyPress(HidUsage::from_encoded(Keycode::A.to_hid_usage())),
109 )?;
110 let after = client.get_key_at(layer_id, key_position)?;
111 println!("After: {after:?}");
112
113 // Change management APIs.
114 let has_changes = client.check_unsaved_changes()?;
115 println!("Unsaved changes: {has_changes}");
116 if has_changes {
117 client.discard_changes()?;
118 }
119
120 Ok(())
121}Sourcepub fn get_keymap(&mut self) -> Result<Keymap, ClientError>
pub fn get_keymap(&mut self) -> Result<Keymap, ClientError>
Returns the current keymap state from the device.
Examples found in repository?
63fn run_example<T: Read + Write>(mut client: StudioClient<T>) -> Result<(), Box<dyn Error>> {
64 let info = client.get_device_info()?;
65 println!("Device: {}", info.name);
66 println!("Lock: {:?}", client.get_lock_state()?);
67
68 let behavior_ids = client.list_all_behaviors()?;
69 println!("Behavior count: {}", behavior_ids.len());
70 if let Some(first_behavior_id) = behavior_ids.first().copied() {
71 let details = client.get_behavior_details(first_behavior_id)?;
72 println!("First behavior: {} ({})", details.id, details.display_name);
73 }
74
75 let keymap = match client.get_keymap() {
76 Ok(keymap) => keymap,
77 Err(ClientError::Meta(_)) => {
78 println!("Keymap request denied (likely locked); press `&studio_unlock` then rerun.");
79 return Ok(());
80 }
81 Err(err) => return Err(Box::new(err)),
82 };
83 println!("Layers: {}", keymap.layers.len());
84
85 let layouts = client.get_physical_layouts()?;
86 println!(
87 "Physical layouts: {} (active index: {})",
88 layouts.layouts.len(),
89 layouts.active_layout_index
90 );
91
92 let Some(first_layer) = keymap.layers.first() else {
93 return Ok(());
94 };
95 if first_layer.bindings.is_empty() {
96 return Ok(());
97 }
98
99 let layer_id = first_layer.id;
100 let key_position = 0;
101
102 let before = client.get_key_at(layer_id, key_position)?;
103 println!("Before: {before:?}");
104
105 client.set_key_at(
106 layer_id,
107 key_position,
108 Behavior::KeyPress(HidUsage::from_encoded(Keycode::A.to_hid_usage())),
109 )?;
110 let after = client.get_key_at(layer_id, key_position)?;
111 println!("After: {after:?}");
112
113 // Change management APIs.
114 let has_changes = client.check_unsaved_changes()?;
115 println!("Unsaved changes: {has_changes}");
116 if has_changes {
117 client.discard_changes()?;
118 }
119
120 Ok(())
121}Sourcepub fn get_physical_layouts(&mut self) -> Result<PhysicalLayouts, ClientError>
pub fn get_physical_layouts(&mut self) -> Result<PhysicalLayouts, ClientError>
Returns available physical layouts and the active layout index.
Examples found in repository?
63fn run_example<T: Read + Write>(mut client: StudioClient<T>) -> Result<(), Box<dyn Error>> {
64 let info = client.get_device_info()?;
65 println!("Device: {}", info.name);
66 println!("Lock: {:?}", client.get_lock_state()?);
67
68 let behavior_ids = client.list_all_behaviors()?;
69 println!("Behavior count: {}", behavior_ids.len());
70 if let Some(first_behavior_id) = behavior_ids.first().copied() {
71 let details = client.get_behavior_details(first_behavior_id)?;
72 println!("First behavior: {} ({})", details.id, details.display_name);
73 }
74
75 let keymap = match client.get_keymap() {
76 Ok(keymap) => keymap,
77 Err(ClientError::Meta(_)) => {
78 println!("Keymap request denied (likely locked); press `&studio_unlock` then rerun.");
79 return Ok(());
80 }
81 Err(err) => return Err(Box::new(err)),
82 };
83 println!("Layers: {}", keymap.layers.len());
84
85 let layouts = client.get_physical_layouts()?;
86 println!(
87 "Physical layouts: {} (active index: {})",
88 layouts.layouts.len(),
89 layouts.active_layout_index
90 );
91
92 let Some(first_layer) = keymap.layers.first() else {
93 return Ok(());
94 };
95 if first_layer.bindings.is_empty() {
96 return Ok(());
97 }
98
99 let layer_id = first_layer.id;
100 let key_position = 0;
101
102 let before = client.get_key_at(layer_id, key_position)?;
103 println!("Before: {before:?}");
104
105 client.set_key_at(
106 layer_id,
107 key_position,
108 Behavior::KeyPress(HidUsage::from_encoded(Keycode::A.to_hid_usage())),
109 )?;
110 let after = client.get_key_at(layer_id, key_position)?;
111 println!("After: {after:?}");
112
113 // Change management APIs.
114 let has_changes = client.check_unsaved_changes()?;
115 println!("Unsaved changes: {has_changes}");
116 if has_changes {
117 client.discard_changes()?;
118 }
119
120 Ok(())
121}Sourcepub fn set_layer_binding(
&mut self,
layer_id: u32,
key_position: i32,
binding: BehaviorBinding,
) -> Result<(), ClientError>
pub fn set_layer_binding( &mut self, layer_id: u32, key_position: i32, binding: BehaviorBinding, ) -> Result<(), ClientError>
Sets a raw behavior binding for a specific layer position.
Sourcepub fn get_key_at(
&mut self,
layer_id: u32,
key_position: i32,
) -> Result<Behavior, ClientError>
pub fn get_key_at( &mut self, layer_id: u32, key_position: i32, ) -> Result<Behavior, ClientError>
Reads a behavior from a specific layer/key position.
Examples found in repository?
63fn run_example<T: Read + Write>(mut client: StudioClient<T>) -> Result<(), Box<dyn Error>> {
64 let info = client.get_device_info()?;
65 println!("Device: {}", info.name);
66 println!("Lock: {:?}", client.get_lock_state()?);
67
68 let behavior_ids = client.list_all_behaviors()?;
69 println!("Behavior count: {}", behavior_ids.len());
70 if let Some(first_behavior_id) = behavior_ids.first().copied() {
71 let details = client.get_behavior_details(first_behavior_id)?;
72 println!("First behavior: {} ({})", details.id, details.display_name);
73 }
74
75 let keymap = match client.get_keymap() {
76 Ok(keymap) => keymap,
77 Err(ClientError::Meta(_)) => {
78 println!("Keymap request denied (likely locked); press `&studio_unlock` then rerun.");
79 return Ok(());
80 }
81 Err(err) => return Err(Box::new(err)),
82 };
83 println!("Layers: {}", keymap.layers.len());
84
85 let layouts = client.get_physical_layouts()?;
86 println!(
87 "Physical layouts: {} (active index: {})",
88 layouts.layouts.len(),
89 layouts.active_layout_index
90 );
91
92 let Some(first_layer) = keymap.layers.first() else {
93 return Ok(());
94 };
95 if first_layer.bindings.is_empty() {
96 return Ok(());
97 }
98
99 let layer_id = first_layer.id;
100 let key_position = 0;
101
102 let before = client.get_key_at(layer_id, key_position)?;
103 println!("Before: {before:?}");
104
105 client.set_key_at(
106 layer_id,
107 key_position,
108 Behavior::KeyPress(HidUsage::from_encoded(Keycode::A.to_hid_usage())),
109 )?;
110 let after = client.get_key_at(layer_id, key_position)?;
111 println!("After: {after:?}");
112
113 // Change management APIs.
114 let has_changes = client.check_unsaved_changes()?;
115 println!("Unsaved changes: {has_changes}");
116 if has_changes {
117 client.discard_changes()?;
118 }
119
120 Ok(())
121}Sourcepub fn resolve_keymap(&mut self) -> Result<Vec<Vec<Behavior>>, ClientError>
pub fn resolve_keymap(&mut self) -> Result<Vec<Vec<Behavior>>, ClientError>
Fetches the keymap and resolves every binding into a typed Behavior.
Returns a Vec of layers, each layer being a Vec<Behavior> matching
the order of bindings in the keymap. It fetches the keymap once and converts all
bindings in a single pass.
Sourcepub fn set_key_at(
&mut self,
layer_id: u32,
key_position: i32,
behavior: Behavior,
) -> Result<(), ClientError>
pub fn set_key_at( &mut self, layer_id: u32, key_position: i32, behavior: Behavior, ) -> Result<(), ClientError>
Set a behavior at a specific layer/key position.
Persist with StudioClient::save_changes or revert with StudioClient::discard_changes.
Examples found in repository?
63fn run_example<T: Read + Write>(mut client: StudioClient<T>) -> Result<(), Box<dyn Error>> {
64 let info = client.get_device_info()?;
65 println!("Device: {}", info.name);
66 println!("Lock: {:?}", client.get_lock_state()?);
67
68 let behavior_ids = client.list_all_behaviors()?;
69 println!("Behavior count: {}", behavior_ids.len());
70 if let Some(first_behavior_id) = behavior_ids.first().copied() {
71 let details = client.get_behavior_details(first_behavior_id)?;
72 println!("First behavior: {} ({})", details.id, details.display_name);
73 }
74
75 let keymap = match client.get_keymap() {
76 Ok(keymap) => keymap,
77 Err(ClientError::Meta(_)) => {
78 println!("Keymap request denied (likely locked); press `&studio_unlock` then rerun.");
79 return Ok(());
80 }
81 Err(err) => return Err(Box::new(err)),
82 };
83 println!("Layers: {}", keymap.layers.len());
84
85 let layouts = client.get_physical_layouts()?;
86 println!(
87 "Physical layouts: {} (active index: {})",
88 layouts.layouts.len(),
89 layouts.active_layout_index
90 );
91
92 let Some(first_layer) = keymap.layers.first() else {
93 return Ok(());
94 };
95 if first_layer.bindings.is_empty() {
96 return Ok(());
97 }
98
99 let layer_id = first_layer.id;
100 let key_position = 0;
101
102 let before = client.get_key_at(layer_id, key_position)?;
103 println!("Before: {before:?}");
104
105 client.set_key_at(
106 layer_id,
107 key_position,
108 Behavior::KeyPress(HidUsage::from_encoded(Keycode::A.to_hid_usage())),
109 )?;
110 let after = client.get_key_at(layer_id, key_position)?;
111 println!("After: {after:?}");
112
113 // Change management APIs.
114 let has_changes = client.check_unsaved_changes()?;
115 println!("Unsaved changes: {has_changes}");
116 if has_changes {
117 client.discard_changes()?;
118 }
119
120 Ok(())
121}Sourcepub fn check_unsaved_changes(&mut self) -> Result<bool, ClientError>
pub fn check_unsaved_changes(&mut self) -> Result<bool, ClientError>
Returns whether there are pending unsaved keymap/layout changes.
Examples found in repository?
63fn run_example<T: Read + Write>(mut client: StudioClient<T>) -> Result<(), Box<dyn Error>> {
64 let info = client.get_device_info()?;
65 println!("Device: {}", info.name);
66 println!("Lock: {:?}", client.get_lock_state()?);
67
68 let behavior_ids = client.list_all_behaviors()?;
69 println!("Behavior count: {}", behavior_ids.len());
70 if let Some(first_behavior_id) = behavior_ids.first().copied() {
71 let details = client.get_behavior_details(first_behavior_id)?;
72 println!("First behavior: {} ({})", details.id, details.display_name);
73 }
74
75 let keymap = match client.get_keymap() {
76 Ok(keymap) => keymap,
77 Err(ClientError::Meta(_)) => {
78 println!("Keymap request denied (likely locked); press `&studio_unlock` then rerun.");
79 return Ok(());
80 }
81 Err(err) => return Err(Box::new(err)),
82 };
83 println!("Layers: {}", keymap.layers.len());
84
85 let layouts = client.get_physical_layouts()?;
86 println!(
87 "Physical layouts: {} (active index: {})",
88 layouts.layouts.len(),
89 layouts.active_layout_index
90 );
91
92 let Some(first_layer) = keymap.layers.first() else {
93 return Ok(());
94 };
95 if first_layer.bindings.is_empty() {
96 return Ok(());
97 }
98
99 let layer_id = first_layer.id;
100 let key_position = 0;
101
102 let before = client.get_key_at(layer_id, key_position)?;
103 println!("Before: {before:?}");
104
105 client.set_key_at(
106 layer_id,
107 key_position,
108 Behavior::KeyPress(HidUsage::from_encoded(Keycode::A.to_hid_usage())),
109 )?;
110 let after = client.get_key_at(layer_id, key_position)?;
111 println!("After: {after:?}");
112
113 // Change management APIs.
114 let has_changes = client.check_unsaved_changes()?;
115 println!("Unsaved changes: {has_changes}");
116 if has_changes {
117 client.discard_changes()?;
118 }
119
120 Ok(())
121}Sourcepub fn save_changes(&mut self) -> Result<(), ClientError>
pub fn save_changes(&mut self) -> Result<(), ClientError>
Saves pending keymap/layout mutations made by methods like StudioClient::set_key_at.
After this succeeds, changes are persisted on the device.
Sourcepub fn discard_changes(&mut self) -> Result<bool, ClientError>
pub fn discard_changes(&mut self) -> Result<bool, ClientError>
Discards pending keymap/layout mutations made since the last save.
Returns true if there were pending changes and they were discarded.
Examples found in repository?
63fn run_example<T: Read + Write>(mut client: StudioClient<T>) -> Result<(), Box<dyn Error>> {
64 let info = client.get_device_info()?;
65 println!("Device: {}", info.name);
66 println!("Lock: {:?}", client.get_lock_state()?);
67
68 let behavior_ids = client.list_all_behaviors()?;
69 println!("Behavior count: {}", behavior_ids.len());
70 if let Some(first_behavior_id) = behavior_ids.first().copied() {
71 let details = client.get_behavior_details(first_behavior_id)?;
72 println!("First behavior: {} ({})", details.id, details.display_name);
73 }
74
75 let keymap = match client.get_keymap() {
76 Ok(keymap) => keymap,
77 Err(ClientError::Meta(_)) => {
78 println!("Keymap request denied (likely locked); press `&studio_unlock` then rerun.");
79 return Ok(());
80 }
81 Err(err) => return Err(Box::new(err)),
82 };
83 println!("Layers: {}", keymap.layers.len());
84
85 let layouts = client.get_physical_layouts()?;
86 println!(
87 "Physical layouts: {} (active index: {})",
88 layouts.layouts.len(),
89 layouts.active_layout_index
90 );
91
92 let Some(first_layer) = keymap.layers.first() else {
93 return Ok(());
94 };
95 if first_layer.bindings.is_empty() {
96 return Ok(());
97 }
98
99 let layer_id = first_layer.id;
100 let key_position = 0;
101
102 let before = client.get_key_at(layer_id, key_position)?;
103 println!("Before: {before:?}");
104
105 client.set_key_at(
106 layer_id,
107 key_position,
108 Behavior::KeyPress(HidUsage::from_encoded(Keycode::A.to_hid_usage())),
109 )?;
110 let after = client.get_key_at(layer_id, key_position)?;
111 println!("After: {after:?}");
112
113 // Change management APIs.
114 let has_changes = client.check_unsaved_changes()?;
115 println!("Unsaved changes: {has_changes}");
116 if has_changes {
117 client.discard_changes()?;
118 }
119
120 Ok(())
121}Sourcepub fn set_active_physical_layout(
&mut self,
index: u32,
) -> Result<Keymap, ClientError>
pub fn set_active_physical_layout( &mut self, index: u32, ) -> Result<Keymap, ClientError>
Sets the active physical layout by index and returns the resulting keymap.
Sourcepub fn move_layer(
&mut self,
start_index: u32,
dest_index: u32,
) -> Result<Keymap, ClientError>
pub fn move_layer( &mut self, start_index: u32, dest_index: u32, ) -> Result<Keymap, ClientError>
Moves a layer from start_index to dest_index and returns the updated keymap.
Sourcepub fn add_layer(&mut self) -> Result<AddLayerResponseDetails, ClientError>
pub fn add_layer(&mut self) -> Result<AddLayerResponseDetails, ClientError>
Adds a layer and returns firmware-provided details about the created layer.
Sourcepub fn remove_layer(&mut self, layer_index: u32) -> Result<(), ClientError>
pub fn remove_layer(&mut self, layer_index: u32) -> Result<(), ClientError>
Removes a layer by index.
Sourcepub fn restore_layer(
&mut self,
layer_id: u32,
at_index: u32,
) -> Result<Layer, ClientError>
pub fn restore_layer( &mut self, layer_id: u32, at_index: u32, ) -> Result<Layer, ClientError>
Restores a previously removed layer at a specific index.
Sourcepub fn set_layer_props(
&mut self,
layer_id: u32,
name: impl Into<String>,
) -> Result<(), ClientError>
pub fn set_layer_props( &mut self, layer_id: u32, name: impl Into<String>, ) -> Result<(), ClientError>
Sets user-facing properties for a layer (currently just name).
Source§impl StudioClient<SerialTransport>
impl StudioClient<SerialTransport>
Sourcepub fn open_serial(path: &str) -> Result<Self, SerialTransportError>
pub fn open_serial(path: &str) -> Result<Self, SerialTransportError>
Convenience constructor for opening a serial transport and wrapping it in a client.