Lua RTOS & board status

The Lua RTOS & board status functions provides information about the operation system and board status. These functions are provided as an extension of the Lua os module.

os.board()

Get information about your board. Deprecated. Use cpu.board()

Arguments: nothing

Returns: the board type, the board subtype, and the board brand. Board subtype and board brand can be empty.

-- Get board information
type, subtype, brand = os.board(); --deprecated, use cpu.board()

-- Print to screen
print("Type: "..type)
print("Subtype: "..subtype)
print("Brand: "..brand)

os.cpu() Deprecated. Use cpu.model()

Get the CPU name and CPU revision number, installed in your board.

Arguments: nothing

Returns: a string, with the CPU name installed on your board.

-- Get the CPU model
cpu = os.cpu(); --deprecated, use cpu.model()

-- Print to screen
print("CPU: "..cpu)

CPU: ESP32 rev 0

os.version()

Get Lua RTOS version installed in your board.

Arguments: nothing

Returns: the operating system name (Lua RTOS), the version number,the system build time (expressed in EPOCH time) and the commit's hash (from github) used in build.

-- Get operating system name and version
oss, version, build, commit = os.version();

-- Print to screen
print("OS: "..oss..", version: "..version..", build: "..build..", commit: "..commit)

OS: Lua RTOS, version: beta 0.1, build: 1495574689, commit: 4d92804451cbec7d3ad545c66a92ffab35c63871

os.resetreason()

Get the reset reason. Deprecated. Use cpu.resetreason()

Arguments: nothing Returns: reset reason.

os.flashEUI()

Get the EUI from Winbond SPI FLASH chips. This EUI is read in the Lua RTOS boot process if the Lua RTOS -> General -> Read SPI flash EUI setting is enabled in Kconfig.

Arguments: nothing. Returns: the SPI FLASH EUI or nil if EUI is not available in your board.

/ > os.flashEUI()
cb6254185b430e2e

os.uptime([table])

Show the Lua RTOS up time on the console, or return a table with the Lua RTOS up time information.

Arguments:

• table (optional): if true, the up time information is returned in a Lua table, if false the up time information is printed on the console.

Returns:

• if table is false: nothing or an exception.

• if table is true: a Lua table with up time information, or an exception, with the following fields:

  • current: a string with the current time in %H:%M format
  • days: up time days
  • hours: up time hours
  • mins: up time minutes
  • secs: up time seconds

/ > os.uptime()
23:26 up  0:19:05

up = os.uptime(true)
print("days: "..up.days..", hours: "..up.hours..", mins: "..up.mins..", secs: "..up.secs)

os.time([os.settime{year=1970, month=1, day=1, hour=0, min=0, sec=0}])

The time function, when called without arguments, returns the current date and time, coded as a number. The time function, when called with arguments, returns the date and time, coded as a number, which was given as parameters. See https://www.lua.org/pil/22.1.html for further details.

/ > os.time()
1552405265

os.date([format, [timestamp]])

The date function, despite its name, is a kind of a reverse of the time function: It converts a number representing the date and time back to some higher-level representation. Its first parameter is a format string, describing the representation we want. The second is the numeric date-time; it defaults to the current date and time. See https://www.lua.org/pil/22.1.html for further details.

/ > table = os.date("*t", 906000490)

/ > os.date("today is %A, in %B")
today is Tuesday, in March

/ > os.date()
Tue Mar 12 15:35:36 2019

os.settime(hours, minutes, seconds, month, day, year)

or

os.settime{os.settime{year=1970, month=1, day=1, hour=0, min=0, sec=0}}

The settime function set's the system clock to the date+time given as parameters. As Lua-RTOS doesn't depict the concept of time zones, this usually should be the GMT time.

/ > os.settime{year=1970, month=1, day=1, hour=0, min=0, sec=0}
0
/ > os.settime{year=1970, month=1, day=1, hour=0, min=1, sec=0}
60