Detect RIOt OS version

RicoUK · 20 August 2021 13:23

Hi,

Is there a nice convenient way to determine which version of RIOT OS I am using form within my application code? I’m hoping for a nice symbol like riot_version or some such

I’ve noticed that the API changes occasionally and I’d like my code to be able to compile and run on multiple versions of the OS.

TIA,

Richard.

aabadie · 20 August 2021 14:14

Hi,

The RIOT_VERSION macro contains this information:

github.com

RIOT-OS/RIOT/blob/bff9cb7f3005fab031765adb0db241f647ef6889/Makefile.include#L980


	$(Q)sed -n -e '1i\
/* Generated file do not edit */' -e '/^#.*/ p' $< > $@
.SECONDARY: $(RIOTBUILD_CONFIG_HEADER_C).in
$(RIOTBUILD_CONFIG_HEADER_C).in: FORCE | $(CLEAN)
	@mkdir -p '$(dir $@)'
	$(Q)'$(RIOTTOOLS)/genconfigheader/genconfigheader.sh' $(CFLAGS_WITH_MACROS) \
		| '$(LAZYSPONGE)' $(LAZYSPONGE_FLAGS) '$@'
CFLAGS_WITH_MACROS += $(CFLAGS)
CFLAGS_WITH_MACROS += -DRIOT_VERSION=\"$(RIOT_VERSION)\"
# MODULE_NAME defines. Declared in 'makefiles/modules.inc.mk'
CFLAGS_WITH_MACROS += $(EXTDEFINES)
CFLAGS += -include '$(RIOTBUILD_CONFIG_HEADER_C)'
# include mcuboot support
include $(RIOTMAKE)/mcuboot.mk
# include Murdock helpers
include $(RIOTMAKE)/murdock.inc.mk

It’s used in the RIOT boot for example:

github.com

RIOT-OS/RIOT/blob/bff9cb7f3005fab031765adb0db241f647ef6889/core/init.c#L39-L42


#ifndef CONFIG_BOOT_MSG_STRING
#define CONFIG_BOOT_MSG_STRING "main(): This is RIOT! (Version: " \
    RIOT_VERSION ")"
#endif

benpicco · 20 August 2021 16:54

I guess we could add something like Linux’ KERNEL_VERSION

#ifndef KERNEL_VERSION
#define KERNEL_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + ((c) > 255 ? 255 : (c)))
#endif

and then

#define RIOT_VERSION_CODE KERNEL_VERSION(2021,7,0)

benpicco · 21 August 2021 12:21

I opened a pull request to add the functionality.