From 4a02949b48ff99d40a10f5e4b9625f624cd94830 Mon Sep 17 00:00:00 2001 From: Jochen Vothknecht <jochen3120@gmail.com> Date: Thu, 2 Jun 2022 08:30:37 +0200 Subject: [PATCH] =?UTF-8?q?moar=5Fpolishing=C2=B2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CLC-qthing/SiliconTorch/NVSExplorer.md | 52 +++++++++++++------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/CLC-qthing/SiliconTorch/NVSExplorer.md b/CLC-qthing/SiliconTorch/NVSExplorer.md index 5fbc2fc..0cf3f13 100644 --- a/CLC-qthing/SiliconTorch/NVSExplorer.md +++ b/CLC-qthing/SiliconTorch/NVSExplorer.md @@ -35,54 +35,54 @@ Not all commands will publish a result, but there may be an `ERROR`-topic in the In the following list, `argument` stands for the message content received on the topic, `NS` and `KEY` denote the used namespace and key. - `ls` - **list namespaces** - topic: `REQUEST/ls` - argument: used as delimiter for concatenating the list (default: `' '`) - description: returns a list of the namespaces found in `NVS` + **topic**: `REQUEST/ls` + **argument**: used as delimiter for concatenating the list (default: `' '`) + **description**: returns a list of the namespaces found in `NVS` - `ls` - **list keys** - topic: `REQUEST/ls/NS` - argument: used as delimiter for concatenating the list (default: `' '`) - description: returns a list of the keys found in namespace `NS` + **topic**: `REQUEST/ls/NS` + **argument**: used as delimiter for concatenating the list (default: `' '`) + **description**: returns a list of the keys found in namespace `NS` - `get` - **get generic value** - topic: `REQUEST/get/NS/KEY` - description: reads the value and returns it in its natural form + **topic**: `REQUEST/get/NS/KEY` + **description**: reads the value and returns it in its natural form - `get_type` - **get type of key** - topic: `REQUEST/get_type/NS/KEY` - description: reads the type and converts it to `string` + **topic**: `REQUEST/get_type/NS/KEY` + **description**: reads the type and converts it to `string` returns `void` in case of non-existing `key` possible return values: `u8`, `u16`, `u32`, `u64`, `i8`, `i16`, `i32`, `i64`, `str`, `blob`, `any`, `void` - `get_raw` - **get generic value** - topic: `REQUEST/get_raw/NS/KEY` - description: returns the value in its binary form, for example `2 bytes` in case of `u16` + **topic**: `REQUEST/get_raw/NS/KEY` + **description**: returns the value in its binary form, for example `2 bytes` in case of `u16` - `get_<float|double>` - **get floating point value** - topic: `REQUEST/get_<float|double>/NS/KEY` - description: reads the value, `reinterpret_cast`s it to `float` or `double` and returns it converted to `string` + **topic**: `REQUEST/get_<float|double>/NS/KEY` + **description**: reads the value, `reinterpret_cast`s it to `float` or `double` and returns it converted to `string` - `set_<float|double>` - **get floating point value** - topic: `REQUEST/get_<float|double>/NS/KEY` - argument: the value to set - description: converts the value from `string` to floating point; `reinterpret_cast`s it to `u32` or `u64` and write it to the `key` + **topic**: `REQUEST/get_<float|double>/NS/KEY` + **argument**: the value to set + **description**: converts the value from `string` to floating point; `reinterpret_cast`s it to `u32` or `u64` and write it to the `key` - `get_<u8|i8|u16|i16|u32|i32|u64|i64>` - **get integer value** (`signed` and `unsigned`) - topic: `REQUEST/get_<u8|i8|u16|i16|u32|i32|u64|i64>/NS/KEY` - description: reads the value, and returns it converted to `string` + **topic**: `REQUEST/get_<u8|i8|u16|i16|u32|i32|u64|i64>/NS/KEY` + **description**: reads the value, and returns it converted to `string` - `set_<u8|i8|u16|i16|u32|i32|u64|i64>` - **set integer value** (`signed` and `unsigned`) - topic: `REQUEST/set_<u8|i8|u16|i16|u32|i32|u64|i64>/NS/KEY` - argument: the value to set - description: converts the message from `string` to `int` and writes it into the `key`; the value is capped to the bounds of the specified type, e.g. `[0, 128]` in case of `set_u8` + **topic**: `REQUEST/set_<u8|i8|u16|i16|u32|i32|u64|i64>/NS/KEY` + **argument**: the value to set + **description**: converts the message from `string` to `int` and writes it into the `key`; the value is capped to the bounds of the specified type, e.g. `[0, 128]` in case of `set_u8` - `get_str` - **get string value** - topic: `REQUEST/get_str/NS/KEY` - description: returns the stored `string` value + **topic**: `REQUEST/get_str/NS/KEY` + **description**: returns the stored `string` value - `get_strlen` - **get string length** - topic: `REQUEST/get_strlen/NS/KEY` - description: returns the length of a stored `string` value + **topic**: `REQUEST/get_strlen/NS/KEY` + **description**: returns the length of a stored `string` value -- GitLab