objc

Modules | Functions
Hardware Interfaces

Managing hardware resources, peripherals, and low-level operations. More...

Collaboration diagram for Hardware Interfaces:

Modules

 ADC
 Analog-to-Digital Converter (ADC) interface for hardware platforms.
 
 GPIO
 General Purpose Input/Output (GPIO) interface for hardware platforms.
 
 I2C
 Inter-Integrated Circuit (I2C) interface.
 
 Infrared
 Infrared receiver interface for capturing and processing IR remote control signals.
 
 LED
 LED control interface for hardware platforms.
 
 Power
 Power management detection of active power source, and approximate battery state.
 
 PWM
 Pulse Width Modulation (PWM) interface for hardware platforms.
 
 SPI
 Serial Peripheral Interface (SPI) interface.
 
 Watchdog
 Watchdog timer abstraction, which can be used to respond to dead processes, and also reset the system programmatically.
 
 WiFi
 Wi-Fi network management interface.
 

Functions

void hw_init (void)
 Initializes the hardware system on startup. More...
 
void hw_exit (void)
 Cleans up the hardware system on shutdown. More...
 
void hw_poll (void)
 Occasional polling function for the hardware system. More...
 

Detailed Description

Managing hardware resources, peripherals, and low-level operations.

Function Documentation

◆ hw_exit()

void hw_exit ( void  )

Cleans up the hardware system on shutdown.

This function should be called at the end of the program to perform any necessary cleanup tasks.

Examples:
examples/runtime/gpio/main.c, examples/runtime/infrared/main.c, examples/runtime/led/main.c, examples/runtime/ntp/main.c, examples/runtime/watchdog/main.c, examples/runtime/wificonnect/main.c, and examples/runtime/wifiscan/main.c.

◆ hw_init()

void hw_init ( void  )

Initializes the hardware system on startup.

This function must be called at the start of the program to initialize the hardware environment.

Examples:
examples/runtime/gpio/main.c, examples/runtime/infrared/main.c, examples/runtime/led/main.c, examples/runtime/ntp/main.c, examples/runtime/watchdog/main.c, examples/runtime/wificonnect/main.c, and examples/runtime/wifiscan/main.c.

◆ hw_poll()

void hw_poll ( void  )

Occasional polling function for the hardware system.

This function should be called periodically to allow the hardware system to perform any necessary background tasks.

Examples:
examples/runtime/ntp/main.c, examples/runtime/watchdog/main.c, examples/runtime/wificonnect/main.c, and examples/runtime/wifiscan/main.c.