API Tutorial

This chapter describes how to use the LuatOS API so that developers are familiar with the basic steps to use it and can run the sample programs provided by LuatOS.

• log
  • Introduction
  • Hardware preparation
  • Software part
    • Log Output
    • Modify log output level
    • modify the log style
• sys
  • Introduction
  • Hardware preparation
  • Software part
    • Initialize a LuatOS task and start it
    • Create a loop in a task and use a delay function
    • Start a single timer or cycle timer
    • Stop a timer
    • Sending and subscribing to user messages
    • Wait for a message in a task
• adc
  • Introduction
  • Hardware preparation
  • Software part
• CRYPTO
  • Introduction
  • Hardware preparation
  • Software usage
• fdb
  • Introduction
  • Hardware preparation
  • Software part
    • Save Data
    • Query data
    • Delete a key
    • Empty the entire fdb database
• DISP
  • Introduction
  • Hardware preparation
  • Software usage
• i2c
  • air101
    • Introduction
    • Hardware preparation
    • Software part
      • Initialize hardware i2c
      • Send command to AHT10 to trigger measurement and reading
  • air103
    • Introduction
    • Hardware preparation
    • Software part
      • Initialize hardware i2c
      • Send command to AHT10 to trigger measurement and reading
  • air105
    • Introduction
    • Hardware preparation
    • Software part
      • Initialize hardware i2c
      • Send command to AHT10 to trigger measurement and reading
• spi
  • air101
    • Introduction
    • Hardware preparation
    • Software part
      • Read and write directly to the SPI channel
        • Initialize CS Pin Manual Control
        • Initialization SPI
        • Manufacturers and devices that read SPI FLASH ID
        • Erase specified address sector
        • Read and write SPI FLASH
        • Disable write enable and turn off the corresponding SPI channel and CS GPIO
      • Abstraction for a SPI device and then read and write
        • Abstract SPi Peripherals
        • Manufacturers and devices that read SPI FLASH ID
        • Erase specified address sector
        • Read and write SPI FLASH
        • Disable write enable and shut down the corresponding SPI channel
    • Full Code
  • air103
    • Introduction
    • Hardware preparation
    • Software part
      • Read and write directly to the SPI channel
        • Initialize CS Pin Manual Control
        • Initialization SPI
        • Manufacturers and devices that read SPI FLASH ID
        • Erase specified address sector
        • Read and write SPI FLASH
        • Disable write enable and turn off the corresponding SPI channel and CS GPIO
      • Abstraction for a SPI device and then read and write
        • Abstract SPi Peripherals
        • Manufacturers and devices that read SPI FLASH ID
        • Erase specified address sector
        • Read and write SPI FLASH
        • Disable write enable and shut down the corresponding SPI channel
    • Full Code
  • air105
    • Introduction
    • Hardware preparation
    • Software part
      • Read and write directly to the SPI channel
        • Initialize CS Pin Manual Control
        • Initialization SPI
        • Manufacturers and devices that read SPI FLASH ID
        • Erase specified address sector
        • Read and write SPI FLASH
        • Disable write enable and shut down the corresponding SPI channel
      • Abstraction for a SPI device and then read and write
        • Abstract SPi Peripherals
        • Manufacturers and devices that read SPI FLASH ID
        • Erase specified address sector
        • Read and write SPI FLASH
        • Disable write enable and shut down the corresponding SPI channel
    • Full Code
• uart
  • air101
    • Introduction
    • Hardware preparation
    • Software part
      • Create two zbuff arrays
      • Initialization uart
      • Register Serial Port Event Callback
        • Receive data of type string
        • Receiving data using zbuff
      • Create a new cycle timer to send data to UART1
        • Send string data
        • Send data using zbuff
      • Full Code
  • air103
    • Introduction
    • Hardware preparation
    • Software part
      • Create two zbuff arrays
      • Initialization uart
      • Register Serial Port Event Callback
        • Receive data of type string
        • Receiving data using zbuff
      • Create a new cycle timer to send data to UART1
        • Send string data
        • Send data using zbuff
      • Full Code
  • air105
    • Introduction
    • Hardware preparation
    • Software part
      • Create two zbuff arrays
      • Initialization uart
      • Register Serial Port Event Callback
        • Receive data of type string
        • Receiving data using zbuff
      • Create a new cycle timer to send data to UART1
        • Send string data
        • Send data using zbuff
      • Full Code
• LCD Drive screen
  • Introduction
  • Hardware preparation
  • Software usage
• mcu
  • air101
    • Introduction
    • Hardware preparation
    • Software part
      • Set the main frequency and query the set main frequency
      • Get Device Unique id
      • Get the number of ticks after startup and the number of ticks per second
      • Convert decimal number to hexadecimal string output
  • air103
    • Introduction
    • Hardware preparation
    • Software part
      • Set the main frequency and query the set main frequency
      • Get Device Unique id
      • Get the number of ticks after startup and the number of ticks per second
      • Convert decimal number to hexadecimal string output
  • air105
    • Introduction
    • Hardware preparation
    • Software part
      • Query main frequency
      • Get Device Unique id
      • Get the number of ticks after startup and the number of ticks per second
      • Convert decimal number to hexadecimal string output
      • Obtain the high-precision tick after startup and calculate the difference between the two ticks.
• PM
  • Introduction
  • Hardware preparation
  • Software usage
• pwm
  • air101
    • Introduction
    • Hardware preparation
    • Software part
      • Turn on pwm output
      • Breathing light effect
  • air103
    • Introduction
    • Hardware preparation
    • Software part
      • Turn on pwm output
      • Breathing light effect
  • air105
    • Introduction
    • Hardware preparation
    • Software part
      • Turn on pwm output
      • Breathing light effect
• RTC
  • Introduction
  • Hardware preparation
  • Software usage
• sfd
  • Introduction
  • Hardware preparation
  • Software usage
• sfud
  • air101
    • Introduction
    • Hardware preparation
    • Software part
      • Initialization sfud
        • Initialize with SPI ID
        • Initialization using SPI DEVICE
      • obtain the flash device information table.
      • Read and write Flash
        • Read and write directly to a specific address
        • mount the sfud lfs file system
      • Full Code
  • air103
    • Introduction
    • Hardware preparation
    • Software part
      • Initialization sfud
        • Initialize with SPI ID
        • Initialization using SPI DEVICE
      • obtain the flash device information table.
      • Read and write Flash
        • Read and write directly to a specific address
        • mount the sfud lfs file system
      • Full Code
  • air105
    • Introduction
    • Hardware preparation
    • Software part
      • Initialization sfud
        • Initialize with SPI ID
        • Initialization using SPI DEVICE
      • obtain the flash device information table.
      • Read and write Flash
        • Read and write directly to a specific address
        • mount the sfud lfs file system
      • Full Code
• timer
  • Introduction
  • Hardware preparation
  • Software part
    • hard blocking