3D-printing/klipper
1
0
Fork 0
mirror of https://github.com/Klipper3d/klipper.git synced 2026-02-09 10:30:46 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: add instructions on how to listen to a TCP socket

Browse source 
Change the API server doc to add informations on the new url to bind on
a unix socket or a tcp socket.

Signed-off-by: Anthony Bourguignon <contact@toniob.net>
This commit is contained in:
Anthony Bourguignon 2025-02-18 18:11:05 +01:00
parent b0481f1110
commit 5e1b6242f8
1 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/API_Server.md
View file

@ -9,16 +9,20 @@ control the Klipper host software.
In order to use the API server, the klippy.py host software must be
started with the `-a` parameter. For example:
```
~/klippy-env/bin/python ~/klipper/klippy/klippy.py ~/printer.cfg -a /tmp/klippy_uds -l /tmp/klippy.log
~/klippy-env/bin/python ~/klipper/klippy/klippy.py ~/printer.cfg -a unix:///tmp/klippy_uds -l /tmp/klippy.log
```
This causes the host software to create a Unix Domain Socket. A client
can then open a connection on that socket and send commands to
Klipper.
You can also use a TCP socket, using the tcp scheme (be careful if you expose Klipper on a public interface) :
```
~/klippy-env/bin/python ~/klipper/klippy/klippy.py ~/printer.cfg -a tcp://127.0.0.1:7120 -l /tmp/klippy.log
```
See the [Moonraker](https://github.com/Arksine/moonraker) project for
a popular tool that can forward HTTP requests to Klipper's API Server
Unix Domain Socket.
a popular tool that can forward HTTP requests to Klipper's API Server.
## Request format
@ -31,7 +35,8 @@ terminated by an ASCII 0x03 character:
Klipper contains a `scripts/whconsole.py` tool that can perform the
above message framing. For example:
```
~/klipper/scripts/whconsole.py /tmp/klippy_uds
~/klipper/scripts/whconsole.py unix:///tmp/klippy_uds
~/klipper/scripts/whconsole.py tcp://127.0.0.1:7120
```
This tool can read a series of JSON commands from stdin, send them to