NTURT Zephyr v0.0.1
NTURT common library for Zephyr RTOS
Loading...
Searching...
No Matches
dashboard.h File Reference

Dashboard and display system. More...

#include <zephyr/devicetree.h>
#include <zephyr/kernel.h>
#include "vcu/dt-bindings/dashboard.h"
+ Include dependency graph for dashboard.h:

Data Structures

struct  dashboard_mode_info
 Information about a dashboard mode. More...
 

Macros

#define NUM_LED   DT_CHILD_NUM_STATUS_OKAY(DT_CHOSEN(nturt_leds))
 Number of LEDs in the dashboard.
 
#define LED_STRIP_LEN   DT_PROP(DT_CHOSEN(nturt_accel_display), chain_length)
 Length of the LED strips.
 
#define LED_BLINK_PERIOD   K_MSEC(250)
 Period for a blinking LED to switch state.
 
#define HOLD_MODIFY_INTERVAL   K_MSEC(100)
 Interval between two modifications when holding.
 

Typedefs

typedef void(* dashboard_mode_trans_t) ()
 

Enumerations

enum  dashboard_component {
  DASHBOARD_SPEED , DASHBOARD_BATTERY , DASHBOARD_ACCEL , DASHBOARD_BRAKE ,
  NUM_DASHBOARD_DISPLAY
}
 Components of the dashboard. More...
 
enum  dashboard_mode { DASHBOARD_NORMAL , DASHBOARD_SETTING , DASHBOARD_TEST , NUM_DASHBOARD_MODE }
 Dashboard modes. More...
 

Functions

int dashboard_brightness_get ()
 Get the current brightness of the dashboard.
 
void dashboard_brightness_set (int brightness)
 Set the brightness of the dashboard.
 
void dashboard_led_set (int led, bool set)
 Set the LED state.
 
void dashboard_clear (enum dashboard_component display)
 Clear the display for a component.
 
void dashboard_set_level (enum dashboard_component display, int level)
 Set the level for a component.
 
void dashboard_set_error (enum dashboard_component display)
 Set error state for a component.
 
void dashboard_apply_selected (enum dashboard_component display)
 Apply the selected state for a component.
 
enum dashboard_mode dashboard_mode_get ()
 Get the current dashboard mode.
 
void dashboard_mode_set (enum dashboard_mode mode)
 Set the dashboard mode.
 
const struct dashboard_mode_info * dashboard_mode_info (enum dashboard_mode mode)
 Get the information about a dashboard mode.
 
int dashboard_settings_save ()
 Save the current dashboard settings.
 

Detailed Description

Dashboard and display system.

Author
quantumspawner
Version
0.0.1
Date
2025-07-07