[OpenBeken] How to get device full name or short name in a script?

Tilator wrote:

@ElektrodaBot How do I get OpenBeken device full name or short name in a script?

Direct answer

In the normal OpenBeken command script / autoexec.bat script, there is currently no documented built-in script variable such as:



So you cannot reliably do:



and expect OpenBeken to expand it.

OpenBeken internally does have both names:

- Full / long device name: returned in C by

CFG_GetDeviceName()

- Short device name: returned in C by

CFG_GetShortDeviceName()

The source shows these functions returning

g_cfg.longDeviceName

and

g_cfg.shortDeviceName

respectively. (github.com)

What you can do

1. To set the names

Use the normal OBK commands:



The command list documents

FriendlyName

as setting the full name, and

ShortName

as setting the short name; the short name is used for MQTT topics. (github.com)

2. To use the device short name in MQTT publishing

Usually you do not need to manually read the short name when publishing from the same device. OBK automatically prefixes non-raw MQTT publishes with the device topic/name. The documented

publish

command example shows that the final topic is built as:



unless you pass raw mode as the third argument. (github.com)

Example:



will publish under this device’s own OBK MQTT prefix.

If you want to publish to an absolute/raw topic, use:



3. In Berry scripting

Berry can read OBK legacy variables with:



but the current generated constants list does not include a short-name or full-name variable; it lists variables such as

$CHn

,

$voltage

,

$current

,

$hour

,

$uptime

, etc. (github.com) The Berry tutorial also shows

getVar("$voltage")

,

getVar("$current")

, and

getVar("$power")

, but not a device-name variable. (elektroda.com)

So this will probably not work unless your firmware build has been modified:



Practical workaround

For now, if you need the name inside a script, define it yourself:

Legacy OBK script



Berry



If you are modifying firmware

The clean firmware-side solution would be to expose two new script constants, for example:



mapped internally to:



The relevant C getters already exist in

new_cfg.c

, so this is mainly a tokenizer/constants exposure issue, not a missing configuration feature. (github.com)

Summary

-

ShortName ...

and

FriendlyName ...

set the names.
- OBK internally has

CFG_GetShortDeviceName()

and

CFG_GetDeviceName()

.
- The current documented script constants do not expose those names.
- In normal scripts, use a hardcoded label or rely on

publish

auto-prefixing.
- For a proper dynamic script variable, firmware support would need to be added.