Quick Start Guide for the PICOUART driver

This is the quick start guide for the PICOUART - Picopower UART, with step-by-step instructions on how to configure and use the driver for a specific use case.The code examples can be copied into e.g the main application loop or any other function that will need to control the PICOUART module.

Use cases

• PICOUART basic usage

PICOUART basic usage

This use case will demonstrate how to initialize the PICOUART module to wakeup system or generate event.

Setup steps

Prerequisites

This module requires the following service

• System Clock Management

picouart_basic_setup_code

Add this to the main loop or a setup function:

if (!osc_is_ready(OSC_ID_OSC32)) {
    osc_enable(OSC_ID_OSC32);
    osc_wait_ready(OSC_ID_OSC32);
}

Or

if (!osc_is_ready(OSC_ID_RC32K)) {
    osc_enable(OSC_ID_RC32K);
    osc_wait_ready(OSC_ID_RC32K);
}

picouart_basic_setup_workflow

1. Init the PICOUART module

   struct picouart_dev_inst dev_inst;
   struct picouart_config config;
   picouart_get_config_defaults(&config);
   picouart_init(&dev_inst, PICOUART, &config);

2. Enable the PICOUART module

   • picouart_enable(PICOUART); 

Usage steps

picouart_basic_usage_code

1. configurate the PICOUART to wakeup system

   • case '0':
         printf("Enter backup mode with start bit wakeup.\r\n");
         config.action = PICOUART_ACTION_WAKEUP_ON_STARTBIT;
         picouart_set_config(&dev_inst, &config);
         bpm_sleep(BPM, BPM_SM_BACKUP);
         break;
     
     case '1':
         printf("Enter backup mode with full frame wakeup.\r\n");
         config.action = PICOUART_ACTION_WAKEUP_ON_FULLFRAME;
         picouart_set_config(&dev_inst, &config);
         bpm_sleep(BPM, BPM_SM_BACKUP);
         break;
     
     case '2':
         printf("Enter backup mode with character match wakeup.\r\n");
         config.action = PICOUART_ACTION_WAKEUP_ON_MATCH;
         config.match = 'L';
         picouart_set_config(&dev_inst, &config);
         bpm_sleep(BPM, BPM_SM_BACKUP);
         break;

2. Or configurate the PICOUART to generate event

   • case '0':
         config.action = PICOUART_ACTION_EVENT_ON_STARTBIT;
         picouart_set_config(&dev_inst, &config);
         break;
     
     case '1':
         config.action = PICOUART_ACTION_EVENT_ON_FULLFRAME;
         picouart_set_config(&dev_inst, &config);
         break;
     
     case '2':
         config.action = PICOUART_ACTION_EVENT_ON_MATCH;
         config.match = 'L';
         picouart_set_config(&dev_inst, &config);
         break;

We can get the received value by

while(!picouart_is_data_ready(&dev_inst)) {
    }
picouart_read(&dev_inst, &data);