From 64ecff471fd68f314e9f749f6596b8f2b5b33c8b Mon Sep 17 00:00:00 2001 From: Red007Master <56399742+Red007Master@users.noreply.github.com> Date: Wed, 27 Nov 2024 10:21:32 +0200 Subject: [PATCH] doc: add example on how to change profile to API documentation (#425) --- API.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/API.md b/API.md index 793fc57b..d7c05467 100644 --- a/API.md +++ b/API.md @@ -25,6 +25,13 @@ Example response: {"status":"ok","data":[{"id":"1002:687F-1043:0555-0000:0b:00.0","name":"Vega 10 XL/XT [Radeon RX Vega 56/64]"}]} ``` +Here's an example of calling the API with arguments to change a profile: +``` +echo '{"command": "set_profile", "args": {"name":"name-of-the-profile"}}' | ncat -U /run/lactd.sock +``` +In this code, `name-of-the-profile` should be replaced with the name of a profile that you've already created in LACT. + + # Commands For the full list of available commands and responses, you can look at the source code of the schema: [requests](lact-schema/src/request.rs), [the basic response structure](lact-schema/src/response.rs) and [all possible types](lact-schema/src/lib.rs).