From 29164963897cff5ec24c7e56ac1c41135940da96 Mon Sep 17 00:00:00 2001 From: Sébastien Dailly Date: Sun, 17 Sep 2023 16:38:37 +0200 Subject: Updated the client and socket server --- readme.rst | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) (limited to 'readme.rst') diff --git a/readme.rst b/readme.rst index f285538..1efcb06 100755 --- a/readme.rst +++ b/readme.rst @@ -109,7 +109,8 @@ the keymap can be: :a string: - The key name will be sent: :json:`"A"` + The key named will be sent: :json:`"A"` (you have to follow the named + declared in the device) :a list: @@ -130,11 +131,6 @@ the keymap can be: null, null, null, null ]} -CircuitPython provide a native library in order `to read or store json`_, and -firmware build upon it (like KMK) are easer to use with. - -.. _`to read or store json`: https://docs.circuitpython.org/en/latest/docs/library/json.html - .. Reading message .. --------------- .. @@ -153,6 +149,22 @@ You can relay the events to another one instance using the network. I'm using this when I'm connected over VNC in order to use the keyboard as if it was plugged directly in the host. + +---------- +The client +---------- + +There is a command-line client, which allow to send a layer directly to the device. + +The client can work in interractive mode (usefull for testing), or in a +one-shot action, sending the json file given with the parameter :literal:`--layer` + ---------- The device ---------- + +CircuitPython provide a native library in order `to read or store json`_, and +firmware build upon it (like KMK) are easer to use with. + +.. _`to read or store json`: https://docs.circuitpython.org/en/latest/docs/library/json.html + -- cgit v1.2.3