Category: Devices

AnyCloud Bluetooth Advertising Scanner (Part 5)

Summary

In this article I will add a new task to the AnyCloud BLE Advertising Scanning application which will save the advertising data into a database.

Story

There is still a boatload of mostly unintelligible advertising data coming ripping onto our screen. It is FINALLY time to start fixing that. In this article I will create a new task called the advertising database task which will hold the history of advertising packets that I have seen. I will update the Bluetooth Manager task to submit the advertising packets to a queue running in the advertising database task.

For this series of articles I will:

Discuss an overview of Bluetooth Application Architecture (Part 1)
Explain how to Start the AnyCloud Bluetooth Stack (Part 1)
Discuss the configuration structure: bt_platform_cfg_setting (Part 1)
Discuss the configuration structure: wiced_bt_cfg_settings (Part 1)
Discuss the Tasks created by the Bluetooth Stack (Part 1)
Build the Basic Project (Part 2)
Explain BLE Advertising - Scanner/Observer (Part 3)
Explain BLE Advertising - Advertiser (Part 3)
How does scanning work in the AnyCloud Bluetooth Stack? (Part 3)
Add Observing to our Project (Part 3)
Program and Test the Project (Part 3)
Add the IoT Expert Bluetooth Utility Library (Part 4)
Mulithreading Dangers (Part 4)
Add a Queue to the Bluetooth Manager Thread (Part 4)
Add a Timer to Process the Queue (Part 4)
A Potential Threading Bug (Part 4)
Add a Scan Off & On Command (Part 4)
Create an Advertising Data Database Task (Part 5)
Update the Advertising Database to Accept Submitted ADV Packets (Part 5)
Update the Bluetooth Manager to Submit Adv Packets (Part 5)
Create an Advertising Data Database (Part 5)
Add a Command to Print the Database (Part 5)
Refactor a silly duplication (Part 6)
Update the print (Part 6)
Add the "decode" command (Part 6)
Add the decode packets functionality (Part 6)
Program and test (Part 6)
Design a new advertising database (Part 7)
Update to the new database (Part 7)
Update printing (Part 7)
Update the advertising add (Part 7)
Create a watch command (Part 7)
Create a record command (Part 7)
Create an erase command (Part 7)
Update the filter data structure (Part 8)
Fix the Add function (Part 8)
Add the filter command (Part 8)
Update the printing (Part 8)
Fix a memory leak (Part 9)
Add packet age (Part 9)
Fix the printing, again (Part 9)
Fix the add packet function (Part 9)
Update the database structure for sort and purge (Part 10)
Add the sort and purge commands (Part 10)
Add the sort functionality (Part 10)
Add the purge functionality (Part 10)
The End & Commentary (Part 10)

All of the code can be found at git@github.com:iotexpert/AnyCloudBLEScanner.git and https://github.com/iotexpert/AnyCloudBLEScanner.git

There are git tags in place starting at part 5 so that you can look at just that version of the code. "git tag" to list the tags. And "git checkout part6" to look at the part 6 version of the code.

Create an Advertising Data Database Task

We need to create the file advertisingDatabase.h which will hold the task prototype (so that main can get going).

#pragma once
void adb_task(void *arg);

#pragma once

void adb_task(void *arg);

Then create the advertisingDatabase.c to hold the actual database code. It will start with the definition of messages which can be sent to the task. For now just “ADB_ADD”. To make things a little bit simpler these command can have two data elements (which I call data0 and data1). Then the main part of the task just

Creates the queue to manage the messages
Process the message until the end of time

#include "FreeRTOS.h"
#include "queue.h"
static QueueHandle_t adb_cmdQueue;
typedef enum {
ADB_ADD,
} adb_cmd_t;
typedef struct
{
adb_cmd_t cmd;
void *data0;
void *data1;
} adb_cmdMsg_t;
void adb_task(void *arg)
{
// setup the queue
adb_cmdMsg_t msg;
adb_cmdQueue = xQueueCreate(10,sizeof(adb_cmdMsg_t));
while(1)
{
BaseType_t status = xQueueReceive(adb_cmdQueue,&msg,portMAX_DELAY);
if(status == pdTRUE) 
{
switch(msg.cmd)
{
case ADB_ADD:
break;
}
}
}
}

#include "FreeRTOS.h"

#include "queue.h"

static QueueHandle_t adb_cmdQueue;

typedef enum {

ADB_ADD,

} adb_cmd_t;

typedef struct

{

adb_cmd_t cmd;

void *data0;

void *data1;

} adb_cmdMsg_t;

void adb_task(void *arg)

{

// setup the queue

adb_cmdMsg_t msg;

adb_cmdQueue = xQueueCreate(10,sizeof(adb_cmdMsg_t));

while(1)

{

BaseType_t status = xQueueReceive(adb_cmdQueue,&msg,portMAX_DELAY);

if(status == pdTRUE)

{

switch(msg.cmd)

{

case ADB_ADD:

break;

}

To start the task, you need to add it to main.c.

xTaskCreate(adb_task,"adv database",configMINIMAL_STACK_SIZE*4,0,1,0);

1	xTaskCreate(adb_task,"adv database",configMINIMAL_STACK_SIZE*4,0,1,0);

When I build and program this, you can now see the new task. Good that working.

AnyCloud> Unhandled Bluetooth Management Event: BTM_LOCAL_IDENTITY_KEYS_REQUEST_EVT
Started BT Stack Succesfully
AnyCloud> tasks
Name          State Priority   Stack  Num
------------------------------------------
usrcmd_ta       X       0       228     5
IDLE            R       0       115     7
Tmr Svc         B       0       223     8
CYBT_HCI_       B       5       950     3
sleep_tas       B       6       221     1
CYBT_BT_T       B       4       1371    2
blinkTask       B       0       98      4
adv datab       B       1       479     6
‘B’ – Blocked
‘R’ – Ready
‘D’ – Deleted (waiting clean up)
‘S’ – Suspended, or Blocked without a timeout
Stack = bytes free at highwater
AnyCloud>

AnyCloud> Unhandled Bluetooth Management Event: BTM_LOCAL_IDENTITY_KEYS_REQUEST_EVT

Started BT Stack Succesfully

AnyCloud> tasks

Name State Priority Stack Num

------------------------------------------

usrcmd_ta X 0 228 5

IDLE R 0 115 7

Tmr Svc B 0 223 8

CYBT_HCI_ B 5 950 3

sleep_tas B 6 221 1

CYBT_BT_T B 4 1371 2

blinkTask B 0 98 4

adv datab B 1 479 6

‘B’ – Blocked

‘R’ – Ready

‘D’ – Deleted (waiting clean up)

‘S’ – Suspended, or Blocked without a timeout

Stack = bytes free at highwater

AnyCloud>

Update the Advertising Database to Accept Submitted ADV Packets

If you recall our original setup was to take advertising packets in the Bluetooth Manager thread and print out the data. The first thing that we want to fix up is the ability of the advertising database task to accept advertising packets which are pushed to its command queue. To prepare for this I create two local variables to hold the data.

void adb_task(void *arg)
{
// setup the queue
adb_cmdMsg_t msg;
wiced_bt_ble_scan_results_t *scan_result;
uint8_t *data;

void adb_task(void *arg)

{

// setup the queue

adb_cmdMsg_t msg;

wiced_bt_ble_scan_results_t *scan_result;

uint8_t *data;

Then I update the ADB_ADD command. My first, and really simple fix, is to grab the printing code from the Bluetooth Manager task. Obviously this won’t be an improvement from the original program as far as the users goes, but it will verify that the tasks are working properly together.

case ADB_ADD:
// Print the MAC Address
scan_result = (wiced_bt_ble_scan_results_t *)msg.data0;
data = (uint8_t *)msg.data1;
printf("MAC: ");
for(int i=0;i<BD_ADDR_LEN;i++)
{
printf("%02X:",scan_result->remote_bd_addr[i]);
}
// Print the RAW Data of the ADV Packet
printf(" Data: ");
int i=0;
while(data[i])
{
for(int j=0;j<data[i];j++)
{
printf("%02X ",data[i+1+j]);
}
i = i + data[i]+1;
}
printf("\n");
free(msg.data0);
free(msg.data1);
break;

case ADB_ADD:

// Print the MAC Address

scan_result = (wiced_bt_ble_scan_results_t *)msg.data0;

data = (uint8_t *)msg.data1;

printf("MAC: ");

for(int i=0;i<BD_ADDR_LEN;i++)

{

printf("%02X:",scan_result->remote_bd_addr[i]);

}

// Print the RAW Data of the ADV Packet

printf(" Data: ");

int i=0;

while(data[i])

{

for(int j=0;j<data[i];j++)

{

printf("%02X ",data[i+1+j]);

}

i = i + data[i]+1;

}

printf("\n");

free(msg.data0);

free(msg.data1);

break;

Then I add a command to the advertisingDatabase.h which the Bluetooth Manager task can call to submit advertising packets

void adb_addAdv(wiced_bt_ble_scan_results_t *scan_result,void *data);

1	void adb_addAdv(wiced_bt_ble_scan_results_t scan_result,void data);

The actual command in advertisingDatabase.c just takes the advertising information, puts it in a command message, then submits it to the command queue.

void adb_addAdv(wiced_bt_ble_scan_results_t *scan_result,void *data)
{
adb_cmdMsg_t msg;
msg.cmd = ADB_ADD;
msg.data0 = (void *)scan_result;
msg.data1 = (void *)data;
xQueueSend(adb_cmdQueue,&msg,0); // If you loose an adv packet it is OK...
}

void adb_addAdv(wiced_bt_ble_scan_results_t *scan_result,void *data)

{

adb_cmdMsg_t msg;

msg.cmd = ADB_ADD;

msg.data0 = (void *)scan_result;

msg.data1 = (void *)data;

xQueueSend(adb_cmdQueue,&msg,0); // If you loose an adv packet it is OK...

}

Update the Bluetooth Manager to Submit Adv Packets

Now I go and edit the bluetoothManager. c to submit packets rather than print them. To do this I greatly simplify the callback. There is one VERY important issue to deal with, which is one of those potential religious war issues. Memory.

When you get the callback from the stack, it gives you POINTERS to data for the advertising packet that reside inside of buffers inside of the stack. As soon as this callback returns this memory is purged. To prevent this data from getting cleaned up by the stack I

Malloc some memory for the wiced_bt_ble_scan_results
Malloc some memory for the advertising data
Make a copy of the data
Submit it to the Advertising Database

I KNOW from the spec that the largest data packet is 31-bytes (actually it is 31-bytes + one more field with length 0). So I know the maximum length is 32-bytes This means that in many situations I will be copying GARBAGE into my buffer if the packet is less than 32 bytes long. I think that this is simpler than calculating the length and then only copying that much data.

void btm_advCallback(wiced_bt_ble_scan_results_t *p_scan_result, uint8_t *p_adv_data)
{
wiced_bt_ble_scan_results_t *scan_result = malloc(sizeof(wiced_bt_ble_scan_results_t));
uint8_t *data = malloc(32);
memcpy(data,p_adv_data,32);
memcpy(scan_result,p_scan_result->remote_bd_addr,BD_ADDR_LEN);
adb_addAdv(scan_result,data);
}

void btm_advCallback(wiced_bt_ble_scan_results_t *p_scan_result, uint8_t *p_adv_data)

{

wiced_bt_ble_scan_results_t *scan_result = malloc(sizeof(wiced_bt_ble_scan_results_t));

uint8_t *data = malloc(32);

memcpy(data,p_adv_data,32);

memcpy(scan_result,p_scan_result->remote_bd_addr,BD_ADDR_LEN);

adb_addAdv(scan_result,data);

}

When I run this updated program I should get the same stream of data coming out on the serial port. Sure enough the new thread is working.

Create an Advertising Data Database

Now, lets create an actual database. To simplify things my database is just an array of structures. One structure per bluetooth device. The structure will contain a pointer to the information about the device it just saw and the actual raw data.

typedef struct {
wiced_bt_ble_scan_results_t *result;
uint8_t *data;
} adb_adv_t ;
#define ADB_MAX_SIZE (40)
adb_adv_t adb_database[ADB_MAX_SIZE];
int adb_db_count=0;

typedef struct {

wiced_bt_ble_scan_results_t *result;

uint8_t *data;

} adb_adv_t ;

#define ADB_MAX_SIZE (40)

adb_adv_t adb_database[ADB_MAX_SIZE];

int adb_db_count=0;

Then I will create several helper functions to work with the database

Find devices in the database given a mac address
Print an entry in the database
Add entries to the database

First, find an entry in the database. This function will search through the database and compare the mac address against the mac address in the database. When the memcmp ==0 meaning it found a match, it will return that entry.

static int adb_db_find(wiced_bt_device_address_t *add)
{
int rval=-1;
for(int i=0;i<adb_db_count;i++)
{
if(memcmp(add,&adb_database[i].result->remote_bd_addr,BD_ADDR_LEN)==0)
{
rval = i;
break;
}
}
return rval;
}

static int adb_db_find(wiced_bt_device_address_t *add)

{

int rval=-1;

for(int i=0;i<adb_db_count;i++)

{

if(memcmp(add,&adb_database[i].result->remote_bd_addr,BD_ADDR_LEN)==0)

{

rval = i;

break;

}

return rval;

}

The print function will make sure that you asked for a legal entry (much must be greater than 0… and less than the max). Then it will print out the mac address and the raw data. In a future post I will add a smarter print out.

static void adb_db_printEntry(int entry)
{
if(!(entry>= 0 && entry <= adb_db_count))
{
printf("Illegal entry\n");
return;
}
printf("%02d MAC: ",entry);
for(int i=0;i<BD_ADDR_LEN;i++)
{
printf("%02X:",adb_database[entry].result->remote_bd_addr[i]);
}
// Print the RAW Data of the ADV Packet
printf(" Data: ");
int i=0;
while(adb_database[entry].data[i])
{
for(int j=0;j<adb_database[entry].data[i];j++)
{
printf("%02X ",adb_database[entry].data[i+1+j]);
}
i = i + adb_database[entry].data[i]+1;
}
printf("\n");
}

static void adb_db_printEntry(int entry)

{

if(!(entry>= 0 && entry <= adb_db_count))

{

printf("Illegal entry\n");

return;

}

printf("%02d MAC: ",entry);

for(int i=0;i<BD_ADDR_LEN;i++)

{

printf("%02X:",adb_database[entry].result->remote_bd_addr[i]);

}

// Print the RAW Data of the ADV Packet

printf(" Data: ");

int i=0;

while(adb_database[entry].data[i])

{

for(int j=0;j<adb_database[entry].data[i];j++)

{

printf("%02X ",adb_database[entry].data[i+1+j]);

}

i = i + adb_database[entry].data[i]+1;

}

printf("\n");

}

To add an entry to the database, first make sure that it isn’t already in the database. Then when you are sure that it isn’t the database, you just add the pointers to your table. You need to make sure and not go beyond the end of the table, and if you did, you will have effectively blown away the last entry in the table. Oh well.

static void adb_db_add(wiced_bt_ble_scan_results_t *scan_result,uint8_t *data)
{
int entry = adb_db_find(&scan_result->remote_bd_addr);
if(entry == -1)
{
adb_database[adb_db_count].result = scan_result;
adb_database[adb_db_count].data = data;
adb_db_printEntry(adb_db_count);
adb_db_count = adb_db_count + 1;
if(adb_db_count == ADB_MAX_SIZE)
{
printf("ADV Table Max Size\n");
adb_db_count = adb_db_count - 1;
}
}
else
{
free(scan_result);
free(data);
}
}

static void adb_db_add(wiced_bt_ble_scan_results_t *scan_result,uint8_t *data)

{

int entry = adb_db_find(&scan_result->remote_bd_addr);

if(entry == -1)

{

adb_database[adb_db_count].result = scan_result;

adb_database[adb_db_count].data = data;

adb_db_printEntry(adb_db_count);

adb_db_count = adb_db_count + 1;

if(adb_db_count == ADB_MAX_SIZE)

{

printf("ADV Table Max Size\n");

adb_db_count = adb_db_count - 1;

}

else

{

free(scan_result);

free(data);

}

Add a Command to Print the Database

Now we want to add the ability to print from the command line. So add a new command message to the list of legal commands.

typedef enum {
ADB_ADD,
ADB_PRINT,
} adb_cmd_t;

typedef enum {

ADB_ADD,

ADB_PRINT,

} adb_cmd_t;

Then create a new function to print. If you send in a “-1” it will print the whole table. Otherwise just print the individual entry.

static void adb_printTable(int entry)
{
if(entry == -1)
{
for(int i=0;i<adb_db_count;i++)
{
adb_db_printEntry(i);
}
}
else
{
adb_db_printEntry(entry);
}
}

static void adb_printTable(int entry)

{

if(entry == -1)

{

for(int i=0;i<adb_db_count;i++)

{

adb_db_printEntry(i);

}

else

{

adb_db_printEntry(entry);

}

Now edit usercmd.c to have the new command line. Notice that I use “sscanf” which obviously has some issues. Too bad.

static int usrcmd_print(int argc, char **argv)
{
if(argc == 1)
{
adb_print(-1); // Print whole table
}
if(argc == 2)
{
int val;
sscanf(argv[1],"%d",&val);
adb_print(val);
}
return 0;
}

static int usrcmd_print(int argc, char **argv)

{

if(argc == 1)

{

adb_print(-1); // Print whole table

}

if(argc == 2)

{

int val;

sscanf(argv[1],"%d",&val);

adb_print(val);

}

return 0;

}

When I program the project it immediately prints out a bunch of devices that are at my house. Then you can see I run the “print” command which prints the table. Finally P do a print 0 to just print the first entry.

In the next article I will add smarter diagnostics to the advertising packets.

AnyCloud Bluetooth Utilities Library

Summary

This article is a discussion of a library of utilities functions that support AnyCloud Bluetooth development. It includes settings to configure the hardware, functions to decode stack events, functions to decode advertising packets etc.

Story

The Cypress, now Infineon, Modus Toolbox team has been working to bring the WICED Bluetooth devices to be closer and more compatible with the PSoC 6 tools. One of the important enablement things we have done is turn on the WICED Bluetooth Host stack on the PSoC 6 so that it can effectively talk to the CYW43XXX Bluetooth / WiFi combo chips.

As I have been using all of the new stuff I found myself adding my own custom functionality…. and after a while I realized (finally) that I should put all of those little helper things into a library, specifically an IoT Expert library. For now this library contains:

The Bluetooth Platform Configuration Settings
Functions to decode stack events
Functions to decode advertising packets

but imagine with time I will add more functions and templates.

bt_platform_cfg_settings

As I discussed in the article AnyCloud Bluetooth Advertising Scanner (Part 1), every single AnyCloud BLE Stack project will require a structure of type wiced_bt_cfg_settings_t. This structure is used to setup the hardware before getting the stack going. Remember you need to make a call like this to initialize the Bluetooth hardware.

cybt_platform_config_init(&bt_platform_cfg_settings);

1	cybt_platform_config_init(&bt_platform_cfg_settings);

At some point this file will be included automatically for you by the Modus Toolbox team, but for now I have added this to my library. This file look like this. Basically a bunch of pin definitions which are set for you automatically by the BSP. Obviously you can make your own, but this should work on all of the Cypress development kits (I think)

#include "cybt_platform_config.h"
#include "cybsp.h"
#include "wiced_bt_stack.h"
const cybt_platform_config_t bt_platform_cfg_settings =
{
.hci_config =
{
.hci_transport = CYBT_HCI_UART,
.hci =
{
.hci_uart =
{
.uart_tx_pin = CYBSP_BT_UART_TX,
.uart_rx_pin = CYBSP_BT_UART_RX,
.uart_rts_pin = CYBSP_BT_UART_RTS,
.uart_cts_pin = CYBSP_BT_UART_CTS,
.baud_rate_for_fw_download = 115200,
.baud_rate_for_feature     = 115200,
.data_bits = 8,
.stop_bits = 1,
.parity = CYHAL_UART_PARITY_NONE,
.flow_control = WICED_TRUE
}
}
},
.controller_config =
{
.bt_power_pin      = CYBSP_BT_POWER,
.sleep_mode =
{
#if (bt_0_power_0_ENABLED == 1) /* BT Power control is enabled in the LPA */
#if (CYCFG_BT_LP_ENABLED == 1) /* Low power is enabled in the LPA, use the LPA configuration */
.sleep_mode_enabled = true,
.device_wakeup_pin = CYCFG_BT_DEV_WAKE_GPIO,
.host_wakeup_pin = CYCFG_BT_HOST_WAKE_GPIO,
.device_wake_polarity = CYCFG_BT_DEV_WAKE_POLARITY,
.host_wake_polarity = CYCFG_BT_HOST_WAKE_IRQ_EVENT
#else /* Low power is disabled in the LPA, disable low power */
.sleep_mode_enabled = false
#endif
#else /* BT Power control is disabled in the LPA – default to BSP low power configuration */
.sleep_mode_enabled = true,
.device_wakeup_pin = CYBSP_BT_DEVICE_WAKE,
.host_wakeup_pin = CYBSP_BT_HOST_WAKE,
.device_wake_polarity = CYBT_WAKE_ACTIVE_LOW,
.host_wake_polarity = CYBT_WAKE_ACTIVE_LOW
#endif
}
},
.task_mem_pool_size    = 2048
};

#include "cybt_platform_config.h"

#include "cybsp.h"

#include "wiced_bt_stack.h"

const cybt_platform_config_t bt_platform_cfg_settings =

{

.hci_config =

{

.hci_transport = CYBT_HCI_UART,

.hci =

{

.hci_uart =

{

.uart_tx_pin = CYBSP_BT_UART_TX,

.uart_rx_pin = CYBSP_BT_UART_RX,

.uart_rts_pin = CYBSP_BT_UART_RTS,

.uart_cts_pin = CYBSP_BT_UART_CTS,

.baud_rate_for_fw_download = 115200,

.baud_rate_for_feature = 115200,

.data_bits = 8,

.stop_bits = 1,

.parity = CYHAL_UART_PARITY_NONE,

.flow_control = WICED_TRUE

}

.controller_config =

{

.bt_power_pin = CYBSP_BT_POWER,

.sleep_mode =

{

#if (bt_0_power_0_ENABLED == 1) /* BT Power control is enabled in the LPA */

#if (CYCFG_BT_LP_ENABLED == 1) /* Low power is enabled in the LPA, use the LPA configuration */

.sleep_mode_enabled = true,

.device_wakeup_pin = CYCFG_BT_DEV_WAKE_GPIO,

.host_wakeup_pin = CYCFG_BT_HOST_WAKE_GPIO,

.device_wake_polarity = CYCFG_BT_DEV_WAKE_POLARITY,

.host_wake_polarity = CYCFG_BT_HOST_WAKE_IRQ_EVENT

#else /* Low power is disabled in the LPA, disable low power */

.sleep_mode_enabled = false

#endif

#else /* BT Power control is disabled in the LPA – default to BSP low power configuration */

.sleep_mode_enabled = true,

.device_wakeup_pin = CYBSP_BT_DEVICE_WAKE,

.host_wakeup_pin = CYBSP_BT_HOST_WAKE,

.device_wake_polarity = CYBT_WAKE_ACTIVE_LOW,

.host_wake_polarity = CYBT_WAKE_ACTIVE_LOW

#endif

}

.task_mem_pool_size = 2048

};

btutil_stack

When you startup the Bluetooth Host stack you are responsible for providing a “management callback” which has the function prototype

typedef wiced_result_t (wiced_bt_management_cback_t) (wiced_bt_management_evt_t event, wiced_bt_management_evt_data_t *p_event_data);

1	typedef wiced_result_t (wiced_bt_management_cback_t) (wiced_bt_management_evt_t event, wiced_bt_management_evt_data_t *p_event_data);

The first parameter is an “event” which is just an enumerated list of possible events by the Bluetooth Host Stack. Here is the actual list.

enum wiced_bt_management_evt_e {
/* Bluetooth status events */
BTM_ENABLED_EVT,                                /**< Bluetooth controller and host stack enabled. Event data: wiced_bt_dev_enabled_t */
BTM_DISABLED_EVT,                               /**< Bluetooth controller and host stack disabled. Event data: NULL */
BTM_POWER_MANAGEMENT_STATUS_EVT,                /**< Power management status change. Event data: wiced_bt_power_mgmt_notification_t */
BTM_RE_START_EVT,                               /**< Bluetooth controller and host stack re-enabled. Event data: tBTM_ENABLED_EVT */
/* Security events */
BTM_PIN_REQUEST_EVT,                            /**< PIN request (used only with legacy devices). Event data: #wiced_bt_dev_name_and_class_t */
BTM_USER_CONFIRMATION_REQUEST_EVT,              /**< received USER_CONFIRMATION_REQUEST event (respond using #wiced_bt_dev_confirm_req_reply). Event data: #wiced_bt_dev_user_cfm_req_t */
BTM_PASSKEY_NOTIFICATION_EVT,                   /**< received USER_PASSKEY_NOTIFY event. Event data: #wiced_bt_dev_user_key_notif_t */
BTM_PASSKEY_REQUEST_EVT,                        /**< received USER_PASSKEY_REQUEST event @cond DUAL_MODE (respond using #wiced_bt_dev_pass_key_req_reply). Event data: #wiced_bt_dev_user_key_req_t @endcond
@note  BR/EDR Only */
BTM_KEYPRESS_NOTIFICATION_EVT,                  /**< received KEYPRESS_NOTIFY event. Event data: #wiced_bt_dev_user_keypress_t */
BTM_PAIRING_IO_CAPABILITIES_BR_EDR_REQUEST_EVT, /**< Requesting IO capabilities for BR/EDR pairing. Event data: #wiced_bt_dev_bredr_io_caps_req_t 
@note  BR/EDR Only */
BTM_PAIRING_IO_CAPABILITIES_BR_EDR_RESPONSE_EVT,/**< Received IO capabilities response for BR/EDR pairing. Event data: @cond DUAL_MODE #wiced_bt_dev_bredr_io_caps_rsp_t @endcond
@note  BR/EDR Only*/
BTM_PAIRING_IO_CAPABILITIES_BLE_REQUEST_EVT,    /**< Requesting IO capabilities for BLE pairing. Slave can check peer io capabilities in event data before updating with local io capabilities. Event data: #wiced_bt_dev_ble_io_caps_req_t */
BTM_PAIRING_COMPLETE_EVT,                       /**< received SIMPLE_PAIRING_COMPLETE event. Event data: #wiced_bt_dev_pairing_cplt_t */
BTM_ENCRYPTION_STATUS_EVT,                      /**< Encryption status change. Event data: #wiced_bt_dev_encryption_status_t */
BTM_SECURITY_REQUEST_EVT,                       /**< Security request (respond using #wiced_bt_ble_security_grant). Event data: #wiced_bt_dev_security_request_t */
BTM_SECURITY_FAILED_EVT,                        /**< Security procedure/authentication failed. Event data: #wiced_bt_dev_security_failed_t */
BTM_SECURITY_ABORTED_EVT,                       /**< Security procedure aborted locally, or unexpected link drop. Event data: #wiced_bt_dev_name_and_class_t */
BTM_READ_LOCAL_OOB_DATA_COMPLETE_EVT,           /**< Result of reading local OOB data @cond DUAL_MODE (#wiced_bt_dev_read_local_oob_data). Event data: #wiced_bt_dev_local_oob_t @endcond 
@note  BR/EDR Only */
BTM_REMOTE_OOB_DATA_REQUEST_EVT,                /**< OOB data from remote device @cond DUAL_MODE (respond using #wiced_bt_dev_remote_oob_data_reply). Event data: #wiced_bt_dev_remote_oob_t @endcond 
@note  BR/EDR Only */
BTM_PAIRED_DEVICE_LINK_KEYS_UPDATE_EVT,         /**< Updated remote device link keys (store device_link_keys to  NV memory). This is the place to
verify that the correct link key has been generated. Event data: #wiced_bt_device_link_keys_t */
BTM_PAIRED_DEVICE_LINK_KEYS_REQUEST_EVT,        /**< Request for stored remote device link keys (restore device_link_keys from NV memory). If successful, return WICED_BT_SUCCESS. Event data: #wiced_bt_device_link_keys_t */
BTM_LOCAL_IDENTITY_KEYS_UPDATE_EVT,             /**< Update local identity key (stored local_identity_keys NV memory). Event data: #wiced_bt_local_identity_keys_t */
BTM_LOCAL_IDENTITY_KEYS_REQUEST_EVT,            /**< Request local identity key (get local_identity_keys from NV memory). If successful, return WICED_BT_SUCCESS. Event data: #wiced_bt_local_identity_keys_t */
BTM_BLE_SCAN_STATE_CHANGED_EVT,                 /**< BLE scan state change. Event data: #wiced_bt_ble_scan_type_t */
BTM_BLE_ADVERT_STATE_CHANGED_EVT,               /**< BLE advertisement state change. Event data: #wiced_bt_ble_advert_mode_t */
/* BLE Secure Connection events */
BTM_SMP_REMOTE_OOB_DATA_REQUEST_EVT,            /**< SMP remote oob data request. Reply using wiced_bt_smp_oob_data_reply. Event data: #wiced_bt_smp_remote_oob_req_t  */
BTM_SMP_SC_REMOTE_OOB_DATA_REQUEST_EVT,         /**< LE secure connection remote oob data request. Reply using wiced_bt_smp_sc_oob_reply. Event data: #wiced_bt_smp_sc_remote_oob_req_t 
@note  BR/EDR Only */
BTM_SMP_SC_LOCAL_OOB_DATA_NOTIFICATION_EVT,     /**< LE secure connection local OOB data (wiced_bt_smp_create_local_sc_oob_data). Event data: #wiced_bt_smp_sc_local_oob_t */
BTM_SCO_CONNECTED_EVT,                          /**< SCO connected event. Event data: @cond DUAL_MODE #wiced_bt_sco_connected_t @endcond
@note  BR/EDR Only */
BTM_SCO_DISCONNECTED_EVT,                       /**< SCO disconnected event. Event data: @cond #wiced_bt_sco_disconnected_t @endcond
@note  BR/EDR Only */
BTM_SCO_CONNECTION_REQUEST_EVT,                 /**< SCO connection request event. Event data: @cond #wiced_bt_sco_connection_request_t @endcond
@note  BR/EDR Only */
BTM_SCO_CONNECTION_CHANGE_EVT,                  /**< SCO connection change event. Event data: @cond #wiced_bt_sco_connection_change_t @endcond
@note  BR/EDR Only */
BTM_BLE_CONNECTION_PARAM_UPDATE,                /**< BLE connection parameter update. Event data: #wiced_bt_ble_connection_param_update_t */
BTM_BLE_PHY_UPDATE_EVT,                         /**< BLE Physical link update. Event data: wiced_bt_ble_phy_update_t */
BTM_LPM_STATE_LOW_POWER,                        /**< BT device wake has been deasserted. Used for Host Stack Use Case. */
BTM_MULTI_ADVERT_RESP_EVENT,                    /**< Multi adv command status event Used for the status of the command sent */
#if SMP_CATB_CONFORMANCE_TESTER == TRUE
BTM_SMP_SC_PEER_INFO_EVT                        /** The Secure Connections support information of the peer device */
#endif
};

enum wiced_bt_management_evt_e {

/* Bluetooth status events */

BTM_ENABLED_EVT, /**< Bluetooth controller and host stack enabled. Event data: wiced_bt_dev_enabled_t */

BTM_DISABLED_EVT, /**< Bluetooth controller and host stack disabled. Event data: NULL */

BTM_POWER_MANAGEMENT_STATUS_EVT, /**< Power management status change. Event data: wiced_bt_power_mgmt_notification_t */

BTM_RE_START_EVT, /**< Bluetooth controller and host stack re-enabled. Event data: tBTM_ENABLED_EVT */

/* Security events */

BTM_PIN_REQUEST_EVT, /**< PIN request (used only with legacy devices). Event data: #wiced_bt_dev_name_and_class_t */

BTM_USER_CONFIRMATION_REQUEST_EVT, /**< received USER_CONFIRMATION_REQUEST event (respond using #wiced_bt_dev_confirm_req_reply). Event data: #wiced_bt_dev_user_cfm_req_t */

BTM_PASSKEY_NOTIFICATION_EVT, /**< received USER_PASSKEY_NOTIFY event. Event data: #wiced_bt_dev_user_key_notif_t */

BTM_PASSKEY_REQUEST_EVT, /**< received USER_PASSKEY_REQUEST event @cond DUAL_MODE (respond using #wiced_bt_dev_pass_key_req_reply). Event data: #wiced_bt_dev_user_key_req_t @endcond

@note BR/EDR Only */

BTM_KEYPRESS_NOTIFICATION_EVT, /**< received KEYPRESS_NOTIFY event. Event data: #wiced_bt_dev_user_keypress_t */

BTM_PAIRING_IO_CAPABILITIES_BR_EDR_REQUEST_EVT, /**< Requesting IO capabilities for BR/EDR pairing. Event data: #wiced_bt_dev_bredr_io_caps_req_t

@note BR/EDR Only */

BTM_PAIRING_IO_CAPABILITIES_BR_EDR_RESPONSE_EVT,/**< Received IO capabilities response for BR/EDR pairing. Event data: @cond DUAL_MODE #wiced_bt_dev_bredr_io_caps_rsp_t @endcond

@note BR/EDR Only*/

BTM_PAIRING_IO_CAPABILITIES_BLE_REQUEST_EVT, /**< Requesting IO capabilities for BLE pairing. Slave can check peer io capabilities in event data before updating with local io capabilities. Event data: #wiced_bt_dev_ble_io_caps_req_t */

BTM_PAIRING_COMPLETE_EVT, /**< received SIMPLE_PAIRING_COMPLETE event. Event data: #wiced_bt_dev_pairing_cplt_t */

BTM_ENCRYPTION_STATUS_EVT, /**< Encryption status change. Event data: #wiced_bt_dev_encryption_status_t */

BTM_SECURITY_REQUEST_EVT, /**< Security request (respond using #wiced_bt_ble_security_grant). Event data: #wiced_bt_dev_security_request_t */

BTM_SECURITY_FAILED_EVT, /**< Security procedure/authentication failed. Event data: #wiced_bt_dev_security_failed_t */

BTM_SECURITY_ABORTED_EVT, /**< Security procedure aborted locally, or unexpected link drop. Event data: #wiced_bt_dev_name_and_class_t */

BTM_READ_LOCAL_OOB_DATA_COMPLETE_EVT, /**< Result of reading local OOB data @cond DUAL_MODE (#wiced_bt_dev_read_local_oob_data). Event data: #wiced_bt_dev_local_oob_t @endcond

@note BR/EDR Only */

BTM_REMOTE_OOB_DATA_REQUEST_EVT, /**< OOB data from remote device @cond DUAL_MODE (respond using #wiced_bt_dev_remote_oob_data_reply). Event data: #wiced_bt_dev_remote_oob_t @endcond

@note BR/EDR Only */

BTM_PAIRED_DEVICE_LINK_KEYS_UPDATE_EVT, /**< Updated remote device link keys (store device_link_keys to NV memory). This is the place to

verify that the correct link key has been generated. Event data: #wiced_bt_device_link_keys_t */

BTM_PAIRED_DEVICE_LINK_KEYS_REQUEST_EVT, /**< Request for stored remote device link keys (restore device_link_keys from NV memory). If successful, return WICED_BT_SUCCESS. Event data: #wiced_bt_device_link_keys_t */

BTM_LOCAL_IDENTITY_KEYS_UPDATE_EVT, /**< Update local identity key (stored local_identity_keys NV memory). Event data: #wiced_bt_local_identity_keys_t */

BTM_LOCAL_IDENTITY_KEYS_REQUEST_EVT, /**< Request local identity key (get local_identity_keys from NV memory). If successful, return WICED_BT_SUCCESS. Event data: #wiced_bt_local_identity_keys_t */

BTM_BLE_SCAN_STATE_CHANGED_EVT, /**< BLE scan state change. Event data: #wiced_bt_ble_scan_type_t */

BTM_BLE_ADVERT_STATE_CHANGED_EVT, /**< BLE advertisement state change. Event data: #wiced_bt_ble_advert_mode_t */

/* BLE Secure Connection events */

BTM_SMP_REMOTE_OOB_DATA_REQUEST_EVT, /**< SMP remote oob data request. Reply using wiced_bt_smp_oob_data_reply. Event data: #wiced_bt_smp_remote_oob_req_t */

BTM_SMP_SC_REMOTE_OOB_DATA_REQUEST_EVT, /**< LE secure connection remote oob data request. Reply using wiced_bt_smp_sc_oob_reply. Event data: #wiced_bt_smp_sc_remote_oob_req_t

@note BR/EDR Only */

BTM_SMP_SC_LOCAL_OOB_DATA_NOTIFICATION_EVT, /**< LE secure connection local OOB data (wiced_bt_smp_create_local_sc_oob_data). Event data: #wiced_bt_smp_sc_local_oob_t */

BTM_SCO_CONNECTED_EVT, /**< SCO connected event. Event data: @cond DUAL_MODE #wiced_bt_sco_connected_t @endcond

@note BR/EDR Only */

BTM_SCO_DISCONNECTED_EVT, /**< SCO disconnected event. Event data: @cond #wiced_bt_sco_disconnected_t @endcond

@note BR/EDR Only */

BTM_SCO_CONNECTION_REQUEST_EVT, /**< SCO connection request event. Event data: @cond #wiced_bt_sco_connection_request_t @endcond

@note BR/EDR Only */

BTM_SCO_CONNECTION_CHANGE_EVT, /**< SCO connection change event. Event data: @cond #wiced_bt_sco_connection_change_t @endcond

@note BR/EDR Only */

BTM_BLE_CONNECTION_PARAM_UPDATE, /**< BLE connection parameter update. Event data: #wiced_bt_ble_connection_param_update_t */

BTM_BLE_PHY_UPDATE_EVT, /**< BLE Physical link update. Event data: wiced_bt_ble_phy_update_t */

BTM_LPM_STATE_LOW_POWER, /**< BT device wake has been deasserted. Used for Host Stack Use Case. */

BTM_MULTI_ADVERT_RESP_EVENT, /**< Multi adv command status event Used for the status of the command sent */

#if SMP_CATB_CONFORMANCE_TESTER == TRUE

BTM_SMP_SC_PEER_INFO_EVT /** The Secure Connections support information of the peer device */

#endif

};

While you are trying to figure out what is going on during the development, it is very useful to be able to print out the name of the events (instead of the numbers). In other words instead of doing

printf("Event = %02X\n",event);

1	printf("Event = %02X\n",event);

it is way better to do

printf("Event Name=%s\n",btutil_getBTEventName(event));

1	printf("Event Name=%s\n",btutil_getBTEventName(event));

While I was looking at an example project I found this function which I thought was awesome.

const char *btutil_getBTEventName(wiced_bt_management_evt_t event)
{
switch ( (int)event )
{
CASE_RETURN_STR(BTM_ENABLED_EVT)
CASE_RETURN_STR(BTM_DISABLED_EVT)
CASE_RETURN_STR(BTM_POWER_MANAGEMENT_STATUS_EVT)
CASE_RETURN_STR(BTM_PIN_REQUEST_EVT)
CASE_RETURN_STR(BTM_USER_CONFIRMATION_REQUEST_EVT)
CASE_RETURN_STR(BTM_PASSKEY_NOTIFICATION_EVT)
CASE_RETURN_STR(BTM_PASSKEY_REQUEST_EVT)
CASE_RETURN_STR(BTM_KEYPRESS_NOTIFICATION_EVT)
CASE_RETURN_STR(BTM_PAIRING_IO_CAPABILITIES_BR_EDR_REQUEST_EVT)
CASE_RETURN_STR(BTM_PAIRING_IO_CAPABILITIES_BR_EDR_RESPONSE_EVT)
CASE_RETURN_STR(BTM_PAIRING_IO_CAPABILITIES_BLE_REQUEST_EVT)
CASE_RETURN_STR(BTM_PAIRING_COMPLETE_EVT)
CASE_RETURN_STR(BTM_ENCRYPTION_STATUS_EVT)
CASE_RETURN_STR(BTM_SECURITY_REQUEST_EVT)
CASE_RETURN_STR(BTM_SECURITY_FAILED_EVT)
CASE_RETURN_STR(BTM_SECURITY_ABORTED_EVT)
CASE_RETURN_STR(BTM_READ_LOCAL_OOB_DATA_COMPLETE_EVT)
CASE_RETURN_STR(BTM_REMOTE_OOB_DATA_REQUEST_EVT)
CASE_RETURN_STR(BTM_PAIRED_DEVICE_LINK_KEYS_UPDATE_EVT)
CASE_RETURN_STR(BTM_PAIRED_DEVICE_LINK_KEYS_REQUEST_EVT)
CASE_RETURN_STR(BTM_LOCAL_IDENTITY_KEYS_UPDATE_EVT)
CASE_RETURN_STR(BTM_LOCAL_IDENTITY_KEYS_REQUEST_EVT)
CASE_RETURN_STR(BTM_BLE_SCAN_STATE_CHANGED_EVT)
CASE_RETURN_STR(BTM_BLE_ADVERT_STATE_CHANGED_EVT)
CASE_RETURN_STR(BTM_SMP_REMOTE_OOB_DATA_REQUEST_EVT)
CASE_RETURN_STR(BTM_SMP_SC_REMOTE_OOB_DATA_REQUEST_EVT)
CASE_RETURN_STR(BTM_SMP_SC_LOCAL_OOB_DATA_NOTIFICATION_EVT)
CASE_RETURN_STR(BTM_SCO_CONNECTED_EVT)
CASE_RETURN_STR(BTM_SCO_DISCONNECTED_EVT)
CASE_RETURN_STR(BTM_SCO_CONNECTION_REQUEST_EVT)
CASE_RETURN_STR(BTM_SCO_CONNECTION_CHANGE_EVT)
CASE_RETURN_STR(BTM_BLE_CONNECTION_PARAM_UPDATE)
#ifdef CYW20819A1
CASE_RETURN_STR(BTM_BLE_PHY_UPDATE_EVT)
#endif
}
return NULL;
}

const char *btutil_getBTEventName(wiced_bt_management_evt_t event)

{

switch ( (int)event )

{

CASE_RETURN_STR(BTM_ENABLED_EVT)

CASE_RETURN_STR(BTM_DISABLED_EVT)

CASE_RETURN_STR(BTM_POWER_MANAGEMENT_STATUS_EVT)

CASE_RETURN_STR(BTM_PIN_REQUEST_EVT)

CASE_RETURN_STR(BTM_USER_CONFIRMATION_REQUEST_EVT)

CASE_RETURN_STR(BTM_PASSKEY_NOTIFICATION_EVT)

CASE_RETURN_STR(BTM_PASSKEY_REQUEST_EVT)

CASE_RETURN_STR(BTM_KEYPRESS_NOTIFICATION_EVT)

CASE_RETURN_STR(BTM_PAIRING_IO_CAPABILITIES_BR_EDR_REQUEST_EVT)

CASE_RETURN_STR(BTM_PAIRING_IO_CAPABILITIES_BR_EDR_RESPONSE_EVT)

CASE_RETURN_STR(BTM_PAIRING_IO_CAPABILITIES_BLE_REQUEST_EVT)

CASE_RETURN_STR(BTM_PAIRING_COMPLETE_EVT)

CASE_RETURN_STR(BTM_ENCRYPTION_STATUS_EVT)

CASE_RETURN_STR(BTM_SECURITY_REQUEST_EVT)

CASE_RETURN_STR(BTM_SECURITY_FAILED_EVT)

CASE_RETURN_STR(BTM_SECURITY_ABORTED_EVT)

CASE_RETURN_STR(BTM_READ_LOCAL_OOB_DATA_COMPLETE_EVT)

CASE_RETURN_STR(BTM_REMOTE_OOB_DATA_REQUEST_EVT)

CASE_RETURN_STR(BTM_PAIRED_DEVICE_LINK_KEYS_UPDATE_EVT)

CASE_RETURN_STR(BTM_PAIRED_DEVICE_LINK_KEYS_REQUEST_EVT)

CASE_RETURN_STR(BTM_LOCAL_IDENTITY_KEYS_UPDATE_EVT)

CASE_RETURN_STR(BTM_LOCAL_IDENTITY_KEYS_REQUEST_EVT)

CASE_RETURN_STR(BTM_BLE_SCAN_STATE_CHANGED_EVT)

CASE_RETURN_STR(BTM_BLE_ADVERT_STATE_CHANGED_EVT)

CASE_RETURN_STR(BTM_SMP_REMOTE_OOB_DATA_REQUEST_EVT)

CASE_RETURN_STR(BTM_SMP_SC_REMOTE_OOB_DATA_REQUEST_EVT)

CASE_RETURN_STR(BTM_SMP_SC_LOCAL_OOB_DATA_NOTIFICATION_EVT)

CASE_RETURN_STR(BTM_SCO_CONNECTED_EVT)

CASE_RETURN_STR(BTM_SCO_DISCONNECTED_EVT)

CASE_RETURN_STR(BTM_SCO_CONNECTION_REQUEST_EVT)

CASE_RETURN_STR(BTM_SCO_CONNECTION_CHANGE_EVT)

CASE_RETURN_STR(BTM_BLE_CONNECTION_PARAM_UPDATE)

#ifdef CYW20819A1

CASE_RETURN_STR(BTM_BLE_PHY_UPDATE_EVT)

#endif

}

return NULL;

}

And then I learned something new when I looked at the “function” CASE_RETURN_STR which used compiler trick to turn an enumerated value into a string.

#define CASE_RETURN_STR(enum_val)          case enum_val: return #enum_val;

1	#define CASE_RETURN_STR(enum_val) case enum_val: return #enum_val;

This allows you to do this in your management callback (notice line 16 where the string is printed out)

wiced_result_t app_bt_management_callback(wiced_bt_management_evt_t event, wiced_bt_management_evt_data_t *p_event_data)
{
wiced_result_t result = WICED_BT_SUCCESS;
switch (event)
{
case BTM_ENABLED_EVT:
if (WICED_BT_SUCCESS == p_event_data->enabled.status)
{
printf("Started BT Stack Succesfully\n");
wiced_bt_ble_observe(WICED_TRUE,0,obv_callback);
}
break;
default:
printf("Unhandled Bluetooth Management Event: %s\n", btutil_getBTEventName(event));
break;
}
return result;
}

wiced_result_t app_bt_management_callback(wiced_bt_management_evt_t event, wiced_bt_management_evt_data_t *p_event_data)

{

wiced_result_t result = WICED_BT_SUCCESS;

switch (event)

{

case BTM_ENABLED_EVT:

if (WICED_BT_SUCCESS == p_event_data->enabled.status)

{

printf("Started BT Stack Succesfully\n");

wiced_bt_ble_observe(WICED_TRUE,0,obv_callback);

}

break;

default:

printf("Unhandled Bluetooth Management Event: %s\n", btutil_getBTEventName(event));

break;

}

return result;

}

It turns out that there are several other places where the stack gives you an event-ish thing. So these functions were created as well

#pragma once
const char *btutil_getBTEventName(wiced_bt_management_evt_t event);
const char *btutil_getBLEAdvertModeName(wiced_bt_ble_advert_mode_t mode);
const char *btutil_getBLEGattDisconnReasonName(wiced_bt_gatt_disconn_reason_t reason);
const char *btutil_getBLEGattStatusName(wiced_bt_gatt_status_t status);

#pragma once

const char *btutil_getBTEventName(wiced_bt_management_evt_t event);

const char *btutil_getBLEAdvertModeName(wiced_bt_ble_advert_mode_t mode);

const char *btutil_getBLEGattDisconnReasonName(wiced_bt_gatt_disconn_reason_t reason);

const char *btutil_getBLEGattStatusName(wiced_bt_gatt_status_t status);

btutil_adv_decode

In AnyCloud Bluetooth Advertising Scanner (Part 3) I discussed the format of the advertising packet. So I created functions which will decode the data in the advertising packets. More on the future article AnyCloud Bluetooth Advertising Scanner (Part 4 or maybe 5 or maybe 6). Here are the functions:

#pragma once
wiced_bool_t btutil_isEddystone(uint8_t *data);
wiced_bool_t btutil_is_iBeacon(uint8_t *data);
wiced_bool_t btutil_isCypress(uint8_t *data);
int btutil_adv_len(uint8_t *packet);
void btutil_adv_printPacketDecode(uint8_t *packet);
void btutil_adv_printPacketBytes(uint8_t *packet);

#pragma once

wiced_bool_t btutil_isEddystone(uint8_t *data);

wiced_bool_t btutil_is_iBeacon(uint8_t *data);

wiced_bool_t btutil_isCypress(uint8_t *data);

int btutil_adv_len(uint8_t *packet);

void btutil_adv_printPacketDecode(uint8_t *packet);

void btutil_adv_printPacketBytes(uint8_t *packet);

btutil

And because I like to have just one include to get access to all of the function I created “btutil.h” which just includes all of the headers in one place.

#pragma once
#include "btutil_adv_decode.h"
#include "btutil_stack.h"
#include "btutil_general.h"
#include "bt_platform_cfg_settings.h"

#pragma once

#include "btutil_adv_decode.h"

#include "btutil_stack.h"

#include "btutil_general.h"

#include "bt_platform_cfg_settings.h"

Add to the IoT Expert Manifest

In order to set it up for my library to live in the library manager I updated the IoT Expert Manifest file to have a link to the GitHub repository

<middleware>
<name>Bluetooth Utilities</name>
<id>btutil</id>
<uri>https://github.com/iotexpert/btutil</uri>
<desc>A library of Bluetooth Debugging Utilties for Cypress PSoC6 Anycloud</desc>
<category>IoT Expert</category>
<req_capabilities>psoc6</req_capabilities>
<versions>
<version flow_version="1.0,2.0">
<num>master</num>
<commit>master</commit>
<desc>master</desc>
</version>
</versions>
</middleware>

<name>Bluetooth Utilities</name>

<id>btutil</id>

<uri>https://github.com/iotexpert/btutil</uri>

<desc>A library of Bluetooth Debugging Utilties for Cypress PSoC6 Anycloud</desc>

<category>IoT Expert</category>

<req_capabilities>psoc6</req_capabilities>

<num>master</num>

<commit>master</commit>

<desc>master</desc>

</version>

</versions>

</middleware>

And now the library manager has the IoT Expert Bluetooth Utilities.

AnyCloud Bluetooth Advertising Scanner (Part 1)

Summary

The first of several articles discussing the use of the AnyCloud BLE Stack to build advertising scanner/observers.

Story

A few summers ago while I was writing the WICED Bluetooth Academy book, I created a WICED based BLE advertising scanner. Actually, I created a framework for the scanner and the remarkable summer intern I had finished the work. That project has been sitting in the source code repository for the Bluetooth class, mostly only shown to face-to-face students. This scanner is built using some of the original code combined with the new AnyCloud Bluetooth SDK. It will act sort-of-like LightBlue or one of the other Bluetooth advertising scanners you might run on your phone, but with a serial console.

Sometime in the last few months we released the Bluetooth SDK for AnyCloud (things have been crazy and I have lost track of time) This SDK has all of the stuff needed to add Bluetooth to your AnyCloud project using one of the Cypress Bluetooth/WiFi combo chips. I had not had a chance to try it out, so I decided to build a Bluetooth project and then port the scanning code.

For this series of articles I will:

Discuss an overview of Bluetooth Application Architecture (Part 1)
Explain how to Start the AnyCloud Bluetooth Stack (Part 1)
Discuss the configuration structure: bt_platform_cfg_setting (Part 1)
Discuss the configuration structure: wiced_bt_cfg_settings (Part 1)
Discuss the Tasks created by the Bluetooth Stack (Part 1)
Build the Basic Project (Part 2)
Explain BLE Advertising - Scanner/Observer (Part 3)
Explain BLE Advertising - Advertiser (Part 3)
How does scanning work in the AnyCloud Bluetooth Stack? (Part 3)
Add Observing to our Project (Part 3)
Program and Test the Project (Part 3)
Add the IoT Expert Bluetooth Utility Library (Part 4)
Mulithreading Dangers (Part 4)
Add a Queue to the Bluetooth Manager Thread (Part 4)
Add a Timer to Process the Queue (Part 4)
A Potential Threading Bug (Part 4)
Add a Scan Off & On Command (Part 4)
Create an Advertising Data Database Task (Part 5)
Update the Advertising Database to Accept Submitted ADV Packets (Part 5)
Update the Bluetooth Manager to Submit Adv Packets (Part 5)
Create an Advertising Data Database (Part 5)
Add a Command to Print the Database (Part 5)
Refactor a silly duplication (Part 6)
Update the print (Part 6)
Add the "decode" command (Part 6)
Add the decode packets functionality (Part 6)
Program and test (Part 6)
Design a new advertising database (Part 7)
Update to the new database (Part 7)
Update printing (Part 7)
Update the advertising add (Part 7)
Create a watch command (Part 7)
Create a record command (Part 7)
Create an erase command (Part 7)
Update the filter data structure (Part 8)
Fix the Add function (Part 8)
Add the filter command (Part 8)
Update the printing (Part 8)
Fix a memory leak (Part 9)
Add packet age (Part 9)
Fix the printing, again (Part 9)
Fix the add packet function (Part 9)
Update the database structure for sort and purge (Part 10)
Add the sort and purge commands (Part 10)
Add the sort functionality (Part 10)
Add the purge functionality (Part 10)
The End & Commentary (Part 10)

All of the code can be found at git@github.com:iotexpert/AnyCloudBLEScanner.git and https://github.com/iotexpert/AnyCloudBLEScanner.git

There are git tags in place starting at part 5 so that you can look at just that version of the code. "git tag" to list the tags. And "git checkout part6" to look at the part 6 version of the code.

Bluetooth Application Architecture

Bluetooth applications are divided into these four pieces

You user application which responds to events and sends messages from/to the Bluetooth host stack
A Bluetooth Host Stack
A Bluetooth Controller Stack
The Bluetooth Radio

These four pieces can be divided into multiple chips, as few as one or as many as four. However, for this article, the project will be built to run on a PSoC 6 + CYW43012 WiFi/Bluetooth Combo chip. Specifically:

My scanner application running on the PSoC 6
The Bluetooth Host Stack running on the PSoC 6
The BlueTooth Controller Firmware running on the CYW43012
A Bluetooth Radio on the CYW43012

But how do they talk? Simple, there is:

A UART Host Controller Interface (HCI) between the two chips
A GPIO to serve as a deep sleep wakeup from the 43012 –> PSoC 6
A GPIO to serve as the bluetooth controller wakeup from the PSoC 6 –> 43012
A GPIO to turn on the Bluetooth regulator from the PSoC 6 –> 43012

Here is the block diagram from the CY8CKIT-062S2-43012 Kit Guide. Notice that signals labeled UART and Control going between the PSoC 6 and the CYW43012.

And when you read more deeply into the schematic you can see the signals labeled

BT_UART_TXD/RXD/CTS/RTS
BT_HOST_WAKE
BT_DEV_WAKE
BT_REG_ON

How to Start the AnyCloud Bluetooth Stack

To actually start the AnyCloud Bluetooth stack you will call two functions

cybt_platform_config_init – that will setup the hardware interface to the CYW43012
wiced_bt_stack_init that will:
1. Start a task to manage the Host Controller Interface
2. Download the controller firmware to the CYW43012
3. Start a task to manage the host stack
4. Initialize both the host and the controller
5. Call you back when that is all done

Here is an example from main.

cybt_platform_config_init(&bt_platform_cfg_settings);
wiced_bt_stack_init (app_bt_management_callback, &wiced_bt_cfg_settings);

1 2	cybt_platform_config_init(&bt_platform_cfg_settings); wiced_bt_stack_init (app_bt_management_callback, &wiced_bt_cfg_settings);

When you look at these two function calls, you will find that you need to provide three things:

A platform hardware configuration structure called bt_platform_cfg_settings
The Bluetooth stack configuration settings structure called wiced_bt_cfg_settings
A management callback called app_bt_management_callback

bt_platform_cfg_settings

The purpose of the hardware configuration structure is to define the UART + parameters and the wakeup GPIOs. Specifically, the hardware configuration structure defines the configuration of the host controller interface (hci)

The HCI transport scheme (in this case UART)
The pins of the UART
Baud Rate
Data Bits
Stop Bits
Parity
Flow Control

And the controller low power behavior (in the .controller_config member)

This is a fairly standard configuration and I think that we should help you by providing this structure somewhere in the BSP. But for now, you need to provide it (in an upcoming article I’ll update the IoT Expert Bluetooth Library to provide it). Here is the specific structure that I will be using.

const cybt_platform_config_t bt_platform_cfg_settings =
{
.hci_config =
{
.hci_transport = CYBT_HCI_UART,
.hci =
{
.hci_uart =
{
.uart_tx_pin = CYBSP_BT_UART_TX,
.uart_rx_pin = CYBSP_BT_UART_RX,
.uart_rts_pin = CYBSP_BT_UART_RTS,
.uart_cts_pin = CYBSP_BT_UART_CTS,
.baud_rate_for_fw_download = 115200,
.baud_rate_for_feature     = 115200,
.data_bits = 8,
.stop_bits = 1,
.parity = CYHAL_UART_PARITY_NONE,
.flow_control = WICED_TRUE
}
}
},
.controller_config =
{
.bt_power_pin      = CYBSP_BT_POWER,
.sleep_mode =
{
#if (bt_0_power_0_ENABLED == 1) /* BT Power control is enabled in the LPA */
#if (CYCFG_BT_LP_ENABLED == 1) /* Low power is enabled in the LPA, use the LPA configuration */
.sleep_mode_enabled = true,
.device_wakeup_pin = CYCFG_BT_DEV_WAKE_GPIO,
.host_wakeup_pin = CYCFG_BT_HOST_WAKE_GPIO,
.device_wake_polarity = CYCFG_BT_DEV_WAKE_POLARITY,
.host_wake_polarity = CYCFG_BT_HOST_WAKE_IRQ_EVENT
#else /* Low power is disabled in the LPA, disable low power */
.sleep_mode_enabled = false
#endif
#else /* BT Power control is disabled in the LPA – default to BSP low power configuration */
.sleep_mode_enabled = true,
.device_wakeup_pin = CYBSP_BT_DEVICE_WAKE,
.host_wakeup_pin = CYBSP_BT_HOST_WAKE,
.device_wake_polarity = CYBT_WAKE_ACTIVE_LOW,
.host_wake_polarity = CYBT_WAKE_ACTIVE_LOW
#endif
}
},
.task_mem_pool_size    = 2048
};

const cybt_platform_config_t bt_platform_cfg_settings =

{

.hci_config =

{

.hci_transport = CYBT_HCI_UART,

.hci =

{

.hci_uart =

{

.uart_tx_pin = CYBSP_BT_UART_TX,

.uart_rx_pin = CYBSP_BT_UART_RX,

.uart_rts_pin = CYBSP_BT_UART_RTS,

.uart_cts_pin = CYBSP_BT_UART_CTS,

.baud_rate_for_fw_download = 115200,

.baud_rate_for_feature = 115200,

.data_bits = 8,

.stop_bits = 1,

.parity = CYHAL_UART_PARITY_NONE,

.flow_control = WICED_TRUE

}

.controller_config =

{

.bt_power_pin = CYBSP_BT_POWER,

.sleep_mode =

{

#if (bt_0_power_0_ENABLED == 1) /* BT Power control is enabled in the LPA */

#if (CYCFG_BT_LP_ENABLED == 1) /* Low power is enabled in the LPA, use the LPA configuration */

.sleep_mode_enabled = true,

.device_wakeup_pin = CYCFG_BT_DEV_WAKE_GPIO,

.host_wakeup_pin = CYCFG_BT_HOST_WAKE_GPIO,

.device_wake_polarity = CYCFG_BT_DEV_WAKE_POLARITY,

.host_wake_polarity = CYCFG_BT_HOST_WAKE_IRQ_EVENT

#else /* Low power is disabled in the LPA, disable low power */

.sleep_mode_enabled = false

#endif

#else /* BT Power control is disabled in the LPA – default to BSP low power configuration */

.sleep_mode_enabled = true,

.device_wakeup_pin = CYBSP_BT_DEVICE_WAKE,

.host_wakeup_pin = CYBSP_BT_HOST_WAKE,

.device_wake_polarity = CYBT_WAKE_ACTIVE_LOW,

.host_wake_polarity = CYBT_WAKE_ACTIVE_LOW

#endif

}

.task_mem_pool_size = 2048

};

wiced_bt_cfg_settings

The Cypress WICED Bluetooth Stack has a boatload of configuration settings. When you call the stack start function you need to provide all of those settings in a structure of type “wiced_bt_cfg_settings_t” which is actually a structure of structures. There are several basic ways to set these settings

Start from scratch and build you own settings
Copy from an example project
Use the Bluetooth Configurator to generate the structure

For the purposes of THIS project I started by copying the structure from on of the example projects and then modifying the three numbers that were relevant to me. Specifically

max_simultanous_link – which I changed to 0 because this is simply a Bluetooth Observer
low_duty_scan_interval – how long in the window to listen for advertising packets
low_duty_scan_window – how wide the window of listening should be

const wiced_bt_cfg_settings_t wiced_bt_cfg_settings =
{
.device_name                         = (uint8_t *)BT_LOCAL_NAME,                                   /**< Local device name (NULL terminated) */
.device_class                        = {0x00, 0x00, 0x00},                                         /**< Local device class */
.security_requirement_mask           = BTM_SEC_NONE,                                               /**< Security requirements mask (BTM_SEC_NONE, or combinination of BTM_SEC_IN_AUTHENTICATE, BTM_SEC_OUT_AUTHENTICATE, BTM_SEC_ENCRYPT (see #wiced_bt_sec_level_e)) */
.max_simultaneous_links              = 0,                                                          /**< Maximum number simultaneous links to different devices */
.ble_scan_cfg =                                                 /* BLE scan settings  */
{
.scan_mode                       = BTM_BLE_SCAN_MODE_PASSIVE,                                  /**< BLE scan mode (BTM_BLE_SCAN_MODE_PASSIVE, BTM_BLE_SCAN_MODE_ACTIVE, or BTM_BLE_SCAN_MODE_NONE) */
/* Advertisement scan configuration */
.high_duty_scan_interval         = WICED_BT_CFG_DEFAULT_HIGH_DUTY_SCAN_INTERVAL,               /**< High duty scan interval */
.high_duty_scan_window           = WICED_BT_CFG_DEFAULT_HIGH_DUTY_SCAN_WINDOW,                 /**< High duty scan window */
.high_duty_scan_duration         = 0,                                                          /**< High duty scan duration in seconds (0 for infinite) */
.low_duty_scan_interval          = 96,                                                         /**< Low duty scan interval  */
.low_duty_scan_window            = 96,                                                         /**< Low duty scan window */
.low_duty_scan_duration          = 0,                                                          /**< Low duty scan duration in seconds (0 for infinite) */
/* Connection scan configuration */
.high_duty_conn_scan_interval    = WICED_BT_CFG_DEFAULT_HIGH_DUTY_CONN_SCAN_INTERVAL,          /**< High duty cycle connection scan interval */
.high_duty_conn_scan_window      = WICED_BT_CFG_DEFAULT_HIGH_DUTY_CONN_SCAN_WINDOW,            /**< High duty cycle connection scan window */
.high_duty_conn_duration         = 0,                                                         /**< High duty cycle connection duration in seconds (0 for infinite) */
.low_duty_conn_scan_interval     = WICED_BT_CFG_DEFAULT_LOW_DUTY_CONN_SCAN_INTERVAL,           /**< Low duty cycle connection scan interval */
.low_duty_conn_scan_window       = WICED_BT_CFG_DEFAULT_LOW_DUTY_CONN_SCAN_WINDOW,             /**< Low duty cycle connection scan window */
.low_duty_conn_duration          = 0,                                                         /**< Low duty cycle connection duration in seconds (0 for infinite) */
/* Connection configuration */
.conn_min_interval               = WICED_BT_CFG_DEFAULT_CONN_MIN_INTERVAL,                     /**< Minimum connection interval */
.conn_max_interval               = WICED_BT_CFG_DEFAULT_CONN_MAX_INTERVAL,                     /**< Maximum connection interval */
.conn_latency                    = WICED_BT_CFG_DEFAULT_CONN_LATENCY,                          /**< Connection latency */
.conn_supervision_timeout        = WICED_BT_CFG_DEFAULT_CONN_SUPERVISION_TIMEOUT,              /**< Connection link supervision timeout */
},
.default_ble_power_level            = 12                                                           /**< Default LE power level, Refer lm_TxPwrTable table for the power range */
};

const wiced_bt_cfg_settings_t wiced_bt_cfg_settings =

{

.device_name = (uint8_t *)BT_LOCAL_NAME, /**< Local device name (NULL terminated) */

.device_class = {0x00, 0x00, 0x00}, /**< Local device class */

.security_requirement_mask = BTM_SEC_NONE, /**< Security requirements mask (BTM_SEC_NONE, or combinination of BTM_SEC_IN_AUTHENTICATE, BTM_SEC_OUT_AUTHENTICATE, BTM_SEC_ENCRYPT (see #wiced_bt_sec_level_e)) */

.max_simultaneous_links = 0, /**< Maximum number simultaneous links to different devices */

.ble_scan_cfg = /* BLE scan settings */

{

.scan_mode = BTM_BLE_SCAN_MODE_PASSIVE, /**< BLE scan mode (BTM_BLE_SCAN_MODE_PASSIVE, BTM_BLE_SCAN_MODE_ACTIVE, or BTM_BLE_SCAN_MODE_NONE) */

/* Advertisement scan configuration */

.high_duty_scan_interval = WICED_BT_CFG_DEFAULT_HIGH_DUTY_SCAN_INTERVAL, /**< High duty scan interval */

.high_duty_scan_window = WICED_BT_CFG_DEFAULT_HIGH_DUTY_SCAN_WINDOW, /**< High duty scan window */

.high_duty_scan_duration = 0, /**< High duty scan duration in seconds (0 for infinite) */

.low_duty_scan_interval = 96, /**< Low duty scan interval */

.low_duty_scan_window = 96, /**< Low duty scan window */

.low_duty_scan_duration = 0, /**< Low duty scan duration in seconds (0 for infinite) */

/* Connection scan configuration */

.high_duty_conn_scan_interval = WICED_BT_CFG_DEFAULT_HIGH_DUTY_CONN_SCAN_INTERVAL, /**< High duty cycle connection scan interval */

.high_duty_conn_scan_window = WICED_BT_CFG_DEFAULT_HIGH_DUTY_CONN_SCAN_WINDOW, /**< High duty cycle connection scan window */

.high_duty_conn_duration = 0, /**< High duty cycle connection duration in seconds (0 for infinite) */

.low_duty_conn_scan_interval = WICED_BT_CFG_DEFAULT_LOW_DUTY_CONN_SCAN_INTERVAL, /**< Low duty cycle connection scan interval */

.low_duty_conn_scan_window = WICED_BT_CFG_DEFAULT_LOW_DUTY_CONN_SCAN_WINDOW, /**< Low duty cycle connection scan window */

.low_duty_conn_duration = 0, /**< Low duty cycle connection duration in seconds (0 for infinite) */

/* Connection configuration */

.conn_min_interval = WICED_BT_CFG_DEFAULT_CONN_MIN_INTERVAL, /**< Minimum connection interval */

.conn_max_interval = WICED_BT_CFG_DEFAULT_CONN_MAX_INTERVAL, /**< Maximum connection interval */

.conn_latency = WICED_BT_CFG_DEFAULT_CONN_LATENCY, /**< Connection latency */

.conn_supervision_timeout = WICED_BT_CFG_DEFAULT_CONN_SUPERVISION_TIMEOUT, /**< Connection link supervision timeout */

.default_ble_power_level = 12 /**< Default LE power level, Refer lm_TxPwrTable table for the power range */

};

app_bt_management_callback

The last thing that you need to provide is a management callback. This function is called by the Bluetooth Stack when a “management event” occurs. There is a big-long-list of enumerated events of type wiced_bt_management_event_t. The events include things like the the stack started “BTM_ENABLED_EVENT”. Each event may have data associated with the event which is passed to you in a pointer to wiced_bt_management_event_data_t.

You typically deal with these events with a giant switch statement like this:

wiced_result_t app_bt_management_callback(wiced_bt_management_evt_t event, wiced_bt_management_evt_data_t *p_event_data)
{
wiced_result_t result = WICED_BT_SUCCESS;
switch (event)
{
case BTM_ENABLED_EVT:
if (WICED_BT_SUCCESS == p_event_data->enabled.status)
{
printf("Stack Started Successfully\n");
}
break;
default:
printf("Unhandled Bluetooth Management Event: 0x%x %s\n", event, btutil_getBTEventName(event));
break;
}
return result;
}

wiced_result_t app_bt_management_callback(wiced_bt_management_evt_t event, wiced_bt_management_evt_data_t *p_event_data)

{

wiced_result_t result = WICED_BT_SUCCESS;

switch (event)

{

case BTM_ENABLED_EVT:

if (WICED_BT_SUCCESS == p_event_data->enabled.status)

{

printf("Stack Started Successfully\n");

}

break;

default:

printf("Unhandled Bluetooth Management Event: 0x%x %s\n", event, btutil_getBTEventName(event));

break;

}

return result;

}

Tasks

The Bluetooth stack on the PSoC6 is operated with two tasks. Specifically, when you call the wiced_bt_stack_init it will startup:

CYBT_HCI_Task – a task that sends and receives HCI packets going to the Radio chip
CY_BT_Task – a task that manages the Bluetooth Host Stack

Here is print of the task list from my project:

AnyCloud> tasks
Name          State Priority   Stack  Num
------------------------------------------
nt shell        X       0       236     5
IDLE            R       0       115     6
blink           B       0       98      4
CYBT_BT_Task    B       4       1371    2
sleep_task      B       6       217     1
CYBT_HCI_Task   B       5       950     3
Tmr Svc         B       6       76      7
‘B’ – Blocked
‘R’ – Ready
‘D’ – Deleted (waiting clean up)
‘S’ – Suspended, or Blocked without a timeout
Stack = bytes free at highwater

AnyCloud> tasks

Name State Priority Stack Num

------------------------------------------

nt shell X 0 236 5

IDLE R 0 115 6

blink B 0 98 4

CYBT_BT_Task B 4 1371 2

sleep_task B 6 217 1

CYBT_HCI_Task B 5 950 3

Tmr Svc B 6 76 7

‘B’ – Blocked

‘R’ – Ready

‘D’ – Deleted (waiting clean up)

‘S’ – Suspended, or Blocked without a timeout

Stack = bytes free at highwater

Now with the background in place, in the next article I will discuss Bluetooth advertising and how to build the observer project.

ModusToolbox 2.2 Template Project – FreeRTOS + NTShell

Summary

This article discusses the new library structure that was released with ModusToolbox 2.2. I explain it by showing the creation of a template project that use FreeRTOS and NT Shell.

Story

I have often started projects from the IoT Expert FreeRTOS template project. I realized the other day that almost always the first thing I do after creating the project is add the NT Shell library. My friend Hassane has a personal mantra that if he is going to do the same job more than once he will always automate it. I should have listened to him on this one because I have done it a bunch of times.

In Modus Toolbox 2.2 we have created a new library scheme which allows sharing of libraries between projects. So this will also be a good example of how that works.

This will also give you another example of adding template projects to your own manifest.

Here is what I am going to do:

Create a project from the IoT Expert FreeRTOS Template
Add the NTShell Library & Examine New Library Structure
Update the Project and Program
Add the Task List functionality (a nice feature of FreeRTOS)
Put the new template on GitHub
Update the IoT Expert App Manifest
Test the new Template

Create & Test a project from the IoT Expert FreeRTOS Template

I will start the whole process by creating new project using my existing base template. The kit that I happen to have on my desk right now is the CY8CKIT-062S2-43012.

Select the IoT Expert FreeRTOS Template and give it a name. Notice that I add “NTShell” to the name (because that is what Im gonna add)

When you click create, Modus will do its magic and build you a complete project.

Today Im going to edit using Visual Studio Code. Actually almost always I edit using Visual Studio Code. You can do all of these tasks using Eclipse as well. To turn my created project into a VSCODE project run “make vscode”

Before getting to far down the road I like to run a build to make sure everything is OK. So “make -j build”

arh (master) IoT_Expert_FreeRTOS_NTShell_Template $ make -j build
Tools Directory: /Applications/ModusToolbox/tools_2.2
CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk
Prebuild operations complete
Commencing build operations...
Tools Directory: /Applications/ModusToolbox/tools_2.2
CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk
Initializing build: MTBShellTemplate Debug CY8CKIT-062S2-43012 GCC_ARM
Auto-discovery in progress...
-> Found 195 .c file(s)
-> Found 46 .S file(s)
-> Found 23 .s file(s)
-> Found 0 .cpp file(s)
-> Found 0 .o file(s)
-> Found 6 .a file(s)
-> Found 491 .h file(s)
-> Found 0 .hpp file(s)
-> Found 0 resource file(s)
Applying filters...
Auto-discovery complete
Constructing build rules...
Build rules construction complete
==============================================================================
= Building application =
==============================================================================
Generating compilation database file...
-> ./build/compile_commands.json
Compilation database file generation complete
Building 183 file(s)
Compiling app file lowPower.c
Compiling app file main.c
Compiling ext file startup_psoc6_02_cm4.S
Compiling ext file cy_syslib_gcc.S
Compiling ext file cycfg.c
Compiling ext file cycfg_capsense.c
Compiling ext file cycfg_clocks.c
....a bunch of stuff deleted
Compiling ext file psoc6_04_cm0p_sleep.c
Compiling ext file cy_retarget_io.c
Linking output file MTBShellTemplate.elf
==============================================================================
= Build complete =
==============================================================================
Calculating memory consumption: CY8C624ABZI-S2D44 GCC_ARM -Og
---------------------------------------------------- 
| Section Name         |  Address      |  Size       | 
---------------------------------------------------- 
| .cy_m0p_image        |  0x10000000   |  6044       | 
| .text                |  0x10002000   |  30280      | 
| .ARM.exidx           |  0x10009648   |  8          | 
| .copy.table          |  0x10009650   |  24         | 
| .zero.table          |  0x10009668   |  8          | 
| .data                |  0x080022e0   |  1320       | 
| .cy_sharedmem        |  0x08002808   |  8          | 
| .noinit              |  0x08002810   |  148        | 
| .bss                 |  0x080028a4   |  1324       | 
| .heap                |  0x08002dd0   |  1030704    | 
---------------------------------------------------- 
Total Internal Flash (Available)          2097152    
Total Internal Flash (Utilized)           39848      
Total Internal SRAM (Available)           1046528    
Total Internal SRAM (Utilized with heap)  1033504    
arh (master) IoT_Expert_FreeRTOS_NTShell_Template $

arh (master) IoT_Expert_FreeRTOS_NTShell_Template $ make -j build

Tools Directory: /Applications/ModusToolbox/tools_2.2

CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk

Prebuild operations complete

Commencing build operations...

Tools Directory: /Applications/ModusToolbox/tools_2.2

CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk

Initializing build: MTBShellTemplate Debug CY8CKIT-062S2-43012 GCC_ARM

Auto-discovery in progress...

-> Found 195 .c file(s)

-> Found 46 .S file(s)

-> Found 23 .s file(s)

-> Found 0 .cpp file(s)

-> Found 0 .o file(s)

-> Found 6 .a file(s)

-> Found 491 .h file(s)

-> Found 0 .hpp file(s)

-> Found 0 resource file(s)

Applying filters...

Auto-discovery complete

Constructing build rules...

Build rules construction complete

==============================================================================

= Building application =

==============================================================================

Generating compilation database file...

-> ./build/compile_commands.json

Compilation database file generation complete

Building 183 file(s)

Compiling app file lowPower.c

Compiling app file main.c

Compiling ext file startup_psoc6_02_cm4.S

Compiling ext file cy_syslib_gcc.S

Compiling ext file cycfg.c

Compiling ext file cycfg_capsense.c

Compiling ext file cycfg_clocks.c

....a bunch of stuff deleted

Compiling ext file psoc6_04_cm0p_sleep.c

Compiling ext file cy_retarget_io.c

Linking output file MTBShellTemplate.elf

==============================================================================

= Build complete =

==============================================================================

Calculating memory consumption: CY8C624ABZI-S2D44 GCC_ARM -Og

----------------------------------------------------

| Section Name | Address | Size |

----------------------------------------------------

| .cy_m0p_image | 0x10000000 | 6044 |

| .text | 0x10002000 | 30280 |

| .ARM.exidx | 0x10009648 | 8 |

| .copy.table | 0x10009650 | 24 |

| .zero.table | 0x10009668 | 8 |

| .data | 0x080022e0 | 1320 |

| .cy_sharedmem | 0x08002808 | 8 |

| .noinit | 0x08002810 | 148 |

| .bss | 0x080028a4 | 1324 |

| .heap | 0x08002dd0 | 1030704 |

----------------------------------------------------

Total Internal Flash (Available) 2097152

Total Internal Flash (Utilized) 39848

Total Internal SRAM (Available) 1046528

Total Internal SRAM (Utilized with heap) 1033504

arh (master) IoT_Expert_FreeRTOS_NTShell_Template $

Then program it, just to make sure. “make program”

arh (master) IoT_Expert_FreeRTOS_NTShell_Template $ make program
Tools Directory: /Applications/ModusToolbox/tools_2.2
CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk
Prebuild operations complete
Commencing build operations...
Tools Directory: /Applications/ModusToolbox/tools_2.2
CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk
Initializing build: MTBShellTemplate Debug CY8CKIT-062S2-43012 GCC_ARM
Auto-discovery in progress...
-> Found 195 .c file(s)
-> Found 46 .S file(s)
-> Found 23 .s file(s)
-> Found 0 .cpp file(s)
-> Found 0 .o file(s)
-> Found 6 .a file(s)
-> Found 491 .h file(s)
-> Found 0 .hpp file(s)
-> Found 0 resource file(s)
Applying filters...
Auto-discovery complete
Constructing build rules...
Build rules construction complete
==============================================================================
= Building application =
==============================================================================
Generating compilation database file...
-> ./build/compile_commands.json
Compilation database file generation complete
Building 183 file(s)
==============================================================================
= Build complete =
==============================================================================
Calculating memory consumption: CY8C624ABZI-S2D44 GCC_ARM -Og
---------------------------------------------------- 
| Section Name         |  Address      |  Size       | 
---------------------------------------------------- 
| .cy_m0p_image        |  0x10000000   |  6044       | 
| .text                |  0x10002000   |  30280      | 
| .ARM.exidx           |  0x10009648   |  8          | 
| .copy.table          |  0x10009650   |  24         | 
| .zero.table          |  0x10009668   |  8          | 
| .data                |  0x080022e0   |  1320       | 
| .cy_sharedmem        |  0x08002808   |  8          | 
| .noinit              |  0x08002810   |  148        | 
| .bss                 |  0x080028a4   |  1324       | 
| .heap                |  0x08002dd0   |  1030704    | 
---------------------------------------------------- 
Total Internal Flash (Available)          2097152    
Total Internal Flash (Utilized)           39848      
Total Internal SRAM (Available)           1046528    
Total Internal SRAM (Utilized with heap)  1033504    
Programming target device... 
Open On-Chip Debugger 0.10.0+dev-4.1.0.1058 (2020-08-11-03:45)
Licensed under GNU GPL v2
For bug reports, read
http://openocd.org/doc/doxygen/bugs.html
Info : auto-selecting first available session transport "swd". To override use 'transport select <transport>'.
adapter speed: 2000 kHz
adapter srst delay: 25
adapter srst pulse_width: 25
** Auto-acquire enabled, use "set ENABLE_ACQUIRE 0" to disable
cortex_m reset_config sysresetreq
cortex_m reset_config sysresetreq
Info : Using CMSIS loader 'CY8C6xxA_SMIF' for bank 'psoc6_smif0_cm0' (footprint 14672 bytes)
Warn : SFlash programming allowed for regions: USER, TOC, KEY
Info : CMSIS-DAP: SWD  Supported
Info : CMSIS-DAP: FW Version = 2.0.0
Info : CMSIS-DAP: Interface Initialised (SWD)
Info : SWCLK/TCK = 1 SWDIO/TMS = 1 TDI = 0 TDO = 0 nTRST = 0 nRESET = 1
Info : CMSIS-DAP: Interface ready
Info : KitProg3: FW version: 1.14.514
Info : KitProg3: Pipelined transfers disabled, please update the firmware
Info : VTarget = 3.221 V
Info : kitprog3: acquiring the device...
Info : clock speed 2000 kHz
Info : SWD DPIDR 0x6ba02477
Info : psoc6.cpu.cm0: hardware has 4 breakpoints, 2 watchpoints
***************************************
** Silicon: 0xE453, Family: 0x102, Rev.: 0x12 (A1)
** Detected Device: CY8C624ABZI-S2D44
** Detected Main Flash size, kb: 2048
** Flash Boot version: 3.1.0.378
** Chip Protection: NORMAL
***************************************
Info : psoc6.cpu.cm4: hardware has 6 breakpoints, 4 watchpoints
Info : starting gdb server for psoc6.cpu.cm0 on 3333
Info : Listening on port 3333 for gdb connections
Info : starting gdb server for psoc6.cpu.cm4 on 3334
Info : Listening on port 3334 for gdb connections
Info : SWD DPIDR 0x6ba02477
Info : kitprog3: acquiring the device...
psoc6.cpu.cm0 halted due to debug-request, current mode: Thread 
xPSR: 0x41000000 pc: 0x00000190 msp: 0x080ff800
** Device acquired successfully
** psoc6.cpu.cm4: Ran after reset and before halt...
psoc6.cpu.cm4 halted due to debug-request, current mode: Thread 
xPSR: 0x01000000 pc: 0x0000012a msp: 0x080ff800
** Programming Started **
auto erase enabled
Info : Flash write discontinued at 0x1000179c, next section at 0x10002000
Info : Padding image section 0 at 0x1000179c with 100 bytes (bank write end alignment)
[100%] [################################] [ Erasing     ]
[100%] [################################] [ Programming ]
Info : Padding image section 1 at 0x10009ba0 with 96 bytes (bank write end alignment)
[100%] [################################] [ Erasing     ]
[100%] [################################] [ Programming ]
wrote 37888 bytes from file /Users/arh/mtb22/IoT_Expert_FreeRTOS_NTShell_Template/build/CY8CKIT-062S2-43012/Debug/MTBShellTemplate.hex in 1.402638s (26.379 KiB/s)
** Programming Finished **
** Verify Started **
verified 37692 bytes in 0.080973s (454.579 KiB/s)
** Verified OK **
** Resetting Target **
Info : SWD DPIDR 0x6ba02477
shutdown command invoked
Info : psoc6.dap: powering down debug domain...
Warn : Failed to power down Debug Domains
arh (master) IoT_Expert_FreeRTOS_NTShell_Template $

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

arh (master) IoT_Expert_FreeRTOS_NTShell_Template $ make program

Tools Directory: /Applications/ModusToolbox/tools_2.2

CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk

Prebuild operations complete

Commencing build operations...

Tools Directory: /Applications/ModusToolbox/tools_2.2

CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk

Initializing build: MTBShellTemplate Debug CY8CKIT-062S2-43012 GCC_ARM

Auto-discovery in progress...

-> Found 195 .c file(s)

-> Found 46 .S file(s)

-> Found 23 .s file(s)

-> Found 0 .cpp file(s)

-> Found 0 .o file(s)

-> Found 6 .a file(s)

-> Found 491 .h file(s)

-> Found 0 .hpp file(s)

-> Found 0 resource file(s)

Applying filters...

Auto-discovery complete

Constructing build rules...

Build rules construction complete

==============================================================================

= Building application =

==============================================================================

Generating compilation database file...

-> ./build/compile_commands.json

Compilation database file generation complete

Building 183 file(s)

==============================================================================

= Build complete =

==============================================================================

Calculating memory consumption: CY8C624ABZI-S2D44 GCC_ARM -Og

----------------------------------------------------

| Section Name | Address | Size |

----------------------------------------------------

| .cy_m0p_image | 0x10000000 | 6044 |

| .text | 0x10002000 | 30280 |

| .ARM.exidx | 0x10009648 | 8 |

| .copy.table | 0x10009650 | 24 |

| .zero.table | 0x10009668 | 8 |

| .data | 0x080022e0 | 1320 |

| .cy_sharedmem | 0x08002808 | 8 |

| .noinit | 0x08002810 | 148 |

| .bss | 0x080028a4 | 1324 |

| .heap | 0x08002dd0 | 1030704 |

----------------------------------------------------

Total Internal Flash (Available) 2097152

Total Internal Flash (Utilized) 39848

Total Internal SRAM (Available) 1046528

Total Internal SRAM (Utilized with heap) 1033504

Programming target device...

Open On-Chip Debugger 0.10.0+dev-4.1.0.1058 (2020-08-11-03:45)

Licensed under GNU GPL v2

For bug reports, read

http://openocd.org/doc/doxygen/bugs.html

Info : auto-selecting first available session transport "swd". To override use 'transport select <transport>'.

adapter speed: 2000 kHz

adapter srst delay: 25

adapter srst pulse_width: 25

** Auto-acquire enabled, use "set ENABLE_ACQUIRE 0" to disable

cortex_m reset_config sysresetreq

Info : Using CMSIS loader 'CY8C6xxA_SMIF' for bank 'psoc6_smif0_cm0' (footprint 14672 bytes)

Warn : SFlash programming allowed for regions: USER, TOC, KEY

Info : CMSIS-DAP: SWD Supported

Info : CMSIS-DAP: FW Version = 2.0.0

Info : CMSIS-DAP: Interface Initialised (SWD)

Info : SWCLK/TCK = 1 SWDIO/TMS = 1 TDI = 0 TDO = 0 nTRST = 0 nRESET = 1

Info : CMSIS-DAP: Interface ready

Info : KitProg3: FW version: 1.14.514

Info : KitProg3: Pipelined transfers disabled, please update the firmware

Info : VTarget = 3.221 V

Info : kitprog3: acquiring the device...

Info : clock speed 2000 kHz

Info : SWD DPIDR 0x6ba02477

Info : psoc6.cpu.cm0: hardware has 4 breakpoints, 2 watchpoints

***************************************

** Silicon: 0xE453, Family: 0x102, Rev.: 0x12 (A1)

** Detected Device: CY8C624ABZI-S2D44

** Detected Main Flash size, kb: 2048

** Flash Boot version: 3.1.0.378

** Chip Protection: NORMAL

***************************************

Info : psoc6.cpu.cm4: hardware has 6 breakpoints, 4 watchpoints

Info : starting gdb server for psoc6.cpu.cm0 on 3333

Info : Listening on port 3333 for gdb connections

Info : starting gdb server for psoc6.cpu.cm4 on 3334

Info : Listening on port 3334 for gdb connections

Info : SWD DPIDR 0x6ba02477

Info : kitprog3: acquiring the device...

psoc6.cpu.cm0 halted due to debug-request, current mode: Thread

xPSR: 0x41000000 pc: 0x00000190 msp: 0x080ff800

** Device acquired successfully

** psoc6.cpu.cm4: Ran after reset and before halt...

psoc6.cpu.cm4 halted due to debug-request, current mode: Thread

xPSR: 0x01000000 pc: 0x0000012a msp: 0x080ff800

** Programming Started **

auto erase enabled

Info : Flash write discontinued at 0x1000179c, next section at 0x10002000

Info : Padding image section 0 at 0x1000179c with 100 bytes (bank write end alignment)

[100%] [################################] [ Erasing ]

[100%] [################################] [ Programming ]

Info : Padding image section 1 at 0x10009ba0 with 96 bytes (bank write end alignment)

[100%] [################################] [ Erasing ]

[100%] [################################] [ Programming ]

wrote 37888 bytes from file /Users/arh/mtb22/IoT_Expert_FreeRTOS_NTShell_Template/build/CY8CKIT-062S2-43012/Debug/MTBShellTemplate.hex in 1.402638s (26.379 KiB/s)

** Programming Finished **

** Verify Started **

verified 37692 bytes in 0.080973s (454.579 KiB/s)

** Verified OK **

** Resetting Target **

Info : SWD DPIDR 0x6ba02477

shutdown command invoked

Info : psoc6.dap: powering down debug domain...

Warn : Failed to power down Debug Domains

arh (master) IoT_Expert_FreeRTOS_NTShell_Template $

Add the NTShell Library & Examine New Library Structure

Everything is working and my basic project has FreeRTOS and a blinking LED. Now let’s add the NT Shell Library. To do this run the library manager by running “make modlibs” (or click on the button in Eclipse). Select Libraries –> IoT Expert –> ntshell

When you press update, the library manager will do its thing again.

When I look in the “deps” directory, I see some new file types called “.mtb”. These files tell your project where to find each of the libraries. Notice that the middleware-ntshell.mtb points to “$$ASSET_REPO$$”. Where is that?

If you have a aook at the Makefile it tell you that it is “../” and “mtb_shared”.

# Relative path to the shared repo location.
#
# All .mtb files have the format, <URI><COMMIT><LOCATION>. If the <LOCATION> field 
# begins with $$ASSET_REPO$$, then the repo is deposited in the path specified by 
# the CY_GETLIBS_SHARED_PATH variable. The default location is one directory level 
# above the current app directory.
# This is used with CY_GETLIBS_SHARED_NAME variable, which specifies the directory name.
CY_GETLIBS_SHARED_PATH=../
# Directory name of the shared repo location.
#
CY_GETLIBS_SHARED_NAME=mtb_shared

# Relative path to the shared repo location.

# All .mtb files have the format, <URI><COMMIT><LOCATION>. If the <LOCATION> field

# begins with $$ASSET_REPO$$, then the repo is deposited in the path specified by

# the CY_GETLIBS_SHARED_PATH variable. The default location is one directory level

# above the current app directory.

# This is used with CY_GETLIBS_SHARED_NAME variable, which specifies the directory name.

CY_GETLIBS_SHARED_PATH=../

# Directory name of the shared repo location.

CY_GETLIBS_SHARED_NAME=mtb_shared

To start editing I will run Visual Studio Code by typing “code .”. The first thing that happens is that it notices that this is a workspace instead of just a directory.

And when you look at the workspace you can see that it knows about both the example project as well as “mtb_shared”. That is sweet.

Update the Project and Program

Now follow the instructions from the middlware-ntshell readme by copying “usrcmd.*” into my project.

arh (master) IoT_Expert_FreeRTOS_NTShell_Template $ cp ../mtb_shared/middleware-ntshell/latest-v2.X/template/psoc6sdk/usrcmd.* .

1	arh (master) IoT_Expert_FreeRTOS_NTShell_Template $ cp ../mtb_shared/middleware-ntshell/latest-v2.X/template/psoc6sdk/usrcmd.* .

Then I edit main.c to

#include “usrcmd.h” on line 8
Start the shell task which is called “usrcmd_task” on line 39

Now buid/project by running “make -j program”

arh (master *) IoT_Expert_FreeRTOS_NTShell_Template $ make -j program
Tools Directory: /Applications/ModusToolbox/tools_2.2
CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk
Prebuild operations complete
Commencing build operations...
Tools Directory: /Applications/ModusToolbox/tools_2.2
CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk
Initializing build: MTBShellTemplate Debug CY8CKIT-062S2-43012 GCC_ARM
Auto-discovery in progress...
-> Found 205 .c file(s)
-> Found 46 .S file(s)
-> Found 23 .s file(s)
-> Found 0 .cpp file(s)
-> Found 0 .o file(s)
-> Found 6 .a file(s)
-> Found 503 .h file(s)
-> Found 0 .hpp file(s)
-> Found 0 resource file(s)
Applying filters...
Auto-discovery complete
Constructing build rules...
Build rules construction complete
==============================================================================
= Building application =
==============================================================================
Generating compilation database file...
-> ./build/compile_commands.json
Compilation database file generation complete
Building 193 file(s)
Compiling app file main.c
Linking output file MTBShellTemplate.elf
==============================================================================
= Build complete =
==============================================================================
Calculating memory consumption: CY8C624ABZI-S2D44 GCC_ARM -Og
---------------------------------------------------- 
| Section Name         |  Address      |  Size       | 
---------------------------------------------------- 
| .cy_m0p_image        |  0x10000000   |  6044       | 
| .text                |  0x10002000   |  52780      | 
| .ARM.exidx           |  0x1000ee2c   |  8          | 
| .copy.table          |  0x1000ee34   |  24         | 
| .zero.table          |  0x1000ee4c   |  8          | 
| .data                |  0x080022e0   |  1688       | 
| .cy_sharedmem        |  0x08002978   |  8          | 
| .noinit              |  0x08002980   |  148        | 
| .bss                 |  0x08002a14   |  2136       | 
| .heap                |  0x08003270   |  1029520    | 
---------------------------------------------------- 
Total Internal Flash (Available)          2097152    
Total Internal Flash (Utilized)           62716      
Total Internal SRAM (Available)           1046528    
Total Internal SRAM (Utilized with heap)  1033500    
Programming target device... 
Open On-Chip Debugger 0.10.0+dev-4.1.0.1058 (2020-08-11-03:45)
Licensed under GNU GPL v2
For bug reports, read
http://openocd.org/doc/doxygen/bugs.html
Info : auto-selecting first available session transport "swd". To override use 'transport select <transport>'.
adapter speed: 2000 kHz
adapter srst delay: 25
adapter srst pulse_width: 25
** Auto-acquire enabled, use "set ENABLE_ACQUIRE 0" to disable
cortex_m reset_config sysresetreq
cortex_m reset_config sysresetreq
Info : Using CMSIS loader 'CY8C6xxA_SMIF' for bank 'psoc6_smif0_cm0' (footprint 14672 bytes)
Warn : SFlash programming allowed for regions: USER, TOC, KEY
Info : CMSIS-DAP: SWD  Supported
Info : CMSIS-DAP: FW Version = 2.0.0
Info : CMSIS-DAP: Interface Initialised (SWD)
Info : SWCLK/TCK = 1 SWDIO/TMS = 1 TDI = 0 TDO = 0 nTRST = 0 nRESET = 1
Info : CMSIS-DAP: Interface ready
Info : KitProg3: FW version: 1.14.514
Info : KitProg3: Pipelined transfers disabled, please update the firmware
Info : VTarget = 3.225 V
Info : kitprog3: acquiring the device...
Info : clock speed 2000 kHz
Info : SWD DPIDR 0x6ba02477
Info : psoc6.cpu.cm0: hardware has 4 breakpoints, 2 watchpoints
***************************************
** Silicon: 0xE453, Family: 0x102, Rev.: 0x12 (A1)
** Detected Device: CY8C624ABZI-S2D44
** Detected Main Flash size, kb: 2048
** Flash Boot version: 3.1.0.378
** Chip Protection: NORMAL
***************************************
Info : psoc6.cpu.cm4: hardware has 6 breakpoints, 4 watchpoints
Info : starting gdb server for psoc6.cpu.cm0 on 3333
Info : Listening on port 3333 for gdb connections
Info : starting gdb server for psoc6.cpu.cm4 on 3334
Info : Listening on port 3334 for gdb connections
Info : SWD DPIDR 0x6ba02477
Info : kitprog3: acquiring the device...
psoc6.cpu.cm0 halted due to debug-request, current mode: Thread 
xPSR: 0x41000000 pc: 0x00000190 msp: 0x080ff800
** Device acquired successfully
** psoc6.cpu.cm4: Ran after reset and before halt...
psoc6.cpu.cm4 halted due to debug-request, current mode: Thread 
xPSR: 0x01000000 pc: 0x0000012a msp: 0x080ff800
** Programming Started **
auto erase enabled
Info : Flash write discontinued at 0x1000179c, next section at 0x10002000
Info : Padding image section 0 at 0x1000179c with 100 bytes (bank write end alignment)
[100%] [################################] [ Erasing     ]
[100%] [################################] [ Programming ]
Info : Padding image section 1 at 0x1000f4f4 with 268 bytes (bank write end alignment)
[100%] [################################] [ Erasing     ]
[100%] [################################] [ Programming ]
wrote 60928 bytes from file /Users/arh/mtb22/IoT_Expert_FreeRTOS_NTShell_Template/build/CY8CKIT-062S2-43012/Debug/MTBShellTemplate.hex in 2.017097s (29.498 KiB/s)
** Programming Finished **
** Verify Started **
verified 60560 bytes in 0.119193s (496.175 KiB/s)
** Verified OK **
** Resetting Target **
Info : SWD DPIDR 0x6ba02477
shutdown command invoked
Info : psoc6.dap: powering down debug domain...
arh (master *) IoT_Expert_FreeRTOS_NTShell_Template $

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

arh (master *) IoT_Expert_FreeRTOS_NTShell_Template $ make -j program

Tools Directory: /Applications/ModusToolbox/tools_2.2

CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk

Prebuild operations complete

Commencing build operations...

Tools Directory: /Applications/ModusToolbox/tools_2.2

CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk

Initializing build: MTBShellTemplate Debug CY8CKIT-062S2-43012 GCC_ARM

Auto-discovery in progress...

-> Found 205 .c file(s)

-> Found 46 .S file(s)

-> Found 23 .s file(s)

-> Found 0 .cpp file(s)

-> Found 0 .o file(s)

-> Found 6 .a file(s)

-> Found 503 .h file(s)

-> Found 0 .hpp file(s)

-> Found 0 resource file(s)

Applying filters...

Auto-discovery complete

Constructing build rules...

Build rules construction complete

==============================================================================

= Building application =

==============================================================================

Generating compilation database file...

-> ./build/compile_commands.json

Compilation database file generation complete

Building 193 file(s)

Compiling app file main.c

Linking output file MTBShellTemplate.elf

==============================================================================

= Build complete =

==============================================================================

Calculating memory consumption: CY8C624ABZI-S2D44 GCC_ARM -Og

----------------------------------------------------

| Section Name | Address | Size |

----------------------------------------------------

| .cy_m0p_image | 0x10000000 | 6044 |

| .text | 0x10002000 | 52780 |

| .ARM.exidx | 0x1000ee2c | 8 |

| .copy.table | 0x1000ee34 | 24 |

| .zero.table | 0x1000ee4c | 8 |

| .data | 0x080022e0 | 1688 |

| .cy_sharedmem | 0x08002978 | 8 |

| .noinit | 0x08002980 | 148 |

| .bss | 0x08002a14 | 2136 |

| .heap | 0x08003270 | 1029520 |

----------------------------------------------------

Total Internal Flash (Available) 2097152

Total Internal Flash (Utilized) 62716

Total Internal SRAM (Available) 1046528

Total Internal SRAM (Utilized with heap) 1033500

Programming target device...

Open On-Chip Debugger 0.10.0+dev-4.1.0.1058 (2020-08-11-03:45)

Licensed under GNU GPL v2

For bug reports, read

http://openocd.org/doc/doxygen/bugs.html

Info : auto-selecting first available session transport "swd". To override use 'transport select <transport>'.

adapter speed: 2000 kHz

adapter srst delay: 25

adapter srst pulse_width: 25

** Auto-acquire enabled, use "set ENABLE_ACQUIRE 0" to disable

cortex_m reset_config sysresetreq

Info : Using CMSIS loader 'CY8C6xxA_SMIF' for bank 'psoc6_smif0_cm0' (footprint 14672 bytes)

Warn : SFlash programming allowed for regions: USER, TOC, KEY

Info : CMSIS-DAP: SWD Supported

Info : CMSIS-DAP: FW Version = 2.0.0

Info : CMSIS-DAP: Interface Initialised (SWD)

Info : SWCLK/TCK = 1 SWDIO/TMS = 1 TDI = 0 TDO = 0 nTRST = 0 nRESET = 1

Info : CMSIS-DAP: Interface ready

Info : KitProg3: FW version: 1.14.514

Info : KitProg3: Pipelined transfers disabled, please update the firmware

Info : VTarget = 3.225 V

Info : kitprog3: acquiring the device...

Info : clock speed 2000 kHz

Info : SWD DPIDR 0x6ba02477

Info : psoc6.cpu.cm0: hardware has 4 breakpoints, 2 watchpoints

***************************************

** Silicon: 0xE453, Family: 0x102, Rev.: 0x12 (A1)

** Detected Device: CY8C624ABZI-S2D44

** Detected Main Flash size, kb: 2048

** Flash Boot version: 3.1.0.378

** Chip Protection: NORMAL

***************************************

Info : psoc6.cpu.cm4: hardware has 6 breakpoints, 4 watchpoints

Info : starting gdb server for psoc6.cpu.cm0 on 3333

Info : Listening on port 3333 for gdb connections

Info : starting gdb server for psoc6.cpu.cm4 on 3334

Info : Listening on port 3334 for gdb connections

Info : SWD DPIDR 0x6ba02477

Info : kitprog3: acquiring the device...

psoc6.cpu.cm0 halted due to debug-request, current mode: Thread

xPSR: 0x41000000 pc: 0x00000190 msp: 0x080ff800

** Device acquired successfully

** psoc6.cpu.cm4: Ran after reset and before halt...

psoc6.cpu.cm4 halted due to debug-request, current mode: Thread

xPSR: 0x01000000 pc: 0x0000012a msp: 0x080ff800

** Programming Started **

auto erase enabled

Info : Flash write discontinued at 0x1000179c, next section at 0x10002000

Info : Padding image section 0 at 0x1000179c with 100 bytes (bank write end alignment)

[100%] [################################] [ Erasing ]

[100%] [################################] [ Programming ]

Info : Padding image section 1 at 0x1000f4f4 with 268 bytes (bank write end alignment)

[100%] [################################] [ Erasing ]

[100%] [################################] [ Programming ]

wrote 60928 bytes from file /Users/arh/mtb22/IoT_Expert_FreeRTOS_NTShell_Template/build/CY8CKIT-062S2-43012/Debug/MTBShellTemplate.hex in 2.017097s (29.498 KiB/s)

** Programming Finished **

** Verify Started **

verified 60560 bytes in 0.119193s (496.175 KiB/s)

** Verified OK **

** Resetting Target **

Info : SWD DPIDR 0x6ba02477

shutdown command invoked

Info : psoc6.dap: powering down debug domain...

arh (master *) IoT_Expert_FreeRTOS_NTShell_Template $

Now I have a functional shell. Here is the serial console.

Add the Task List functionality

In the main.c above I started up the usrcmd_task with a stack size of config_MINIMAL_STACK_SIZE * 4. Where did I get that? Well the first couple of times I did this it crashed by running out of stack so I tried bigger and bigger numbers until it stopped crashing. This is a kind of a pain in the ass. If you know FreeRTOS there is a function called “vTaskList” which will give you stats about the tasks.

In order to use that function you need to turn it on. Notice that I #ifdef and #if to see if it is turned on inside of usrcmd.c

#ifdef configUSE_TRACE_FACILITY
#if configUSE_STATS_FORMATTING_FUNCTIONS ==1
static int usrcmd_list(int argc, char **argv);
#endif
#endif

#ifdef configUSE_TRACE_FACILITY

#if configUSE_STATS_FORMATTING_FUNCTIONS ==1

static int usrcmd_list(int argc, char **argv);

#endif

So let’s turn it on by editing “FreeRTOSConfig.h” and enabling the two required defines.

#define configUSE_TRACE_FACILITY					1
#define configUSE_STATS_FORMATTING_FUNCTIONS        1

1 2	#define configUSE_TRACE_FACILITY 1 #define configUSE_STATS_FORMATTING_FUNCTIONS 1

Now build/program.

arh (master *) IoT_Expert_FreeRTOS_NTShell_Template $ make -j program
Tools Directory: /Applications/ModusToolbox/tools_2.2
CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk
Prebuild operations complete
Commencing build operations...
Tools Directory: /Applications/ModusToolbox/tools_2.2
CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk
Initializing build: MTBShellTemplate Debug CY8CKIT-062S2-43012 GCC_ARM
Auto-discovery in progress...
-> Found 205 .c file(s)
-> Found 46 .S file(s)
-> Found 23 .s file(s)
-> Found 0 .cpp file(s)
-> Found 0 .o file(s)
-> Found 6 .a file(s)
-> Found 503 .h file(s)
-> Found 0 .hpp file(s)
-> Found 0 resource file(s)
Applying filters...
Auto-discovery complete
Constructing build rules...
Build rules construction complete
==============================================================================
= Building application =
==============================================================================
Generating compilation database file...
-> ./build/compile_commands.json
Compilation database file generation complete
Building 193 file(s)
Compiling app file lowPower.c
Compiling app file main.c
Compiling app file usrcmd.c
Compiling ext file croutine.c
Compiling ext file event_groups.c
Compiling ext file list.c
Compiling ext file heap_1.c
Compiling ext file heap_2.c
Compiling ext file heap_3.c
Compiling ext file heap_4.c
Compiling ext file heap_5.c
Compiling ext file port.c
Compiling ext file queue.c
Compiling ext file stream_buffer.c
Compiling ext file tasks.c
Compiling ext file timers.c
Compiling ext file psoc6_ntshell_port.c
Linking output file MTBShellTemplate.elf
==============================================================================
= Build complete =
==============================================================================
Calculating memory consumption: CY8C624ABZI-S2D44 GCC_ARM -Og
---------------------------------------------------- 
| Section Name         |  Address      |  Size       | 
---------------------------------------------------- 
| .cy_m0p_image        |  0x10000000   |  6044       | 
| .text                |  0x10002000   |  54876      | 
| .ARM.exidx           |  0x1000f65c   |  8          | 
| .copy.table          |  0x1000f664   |  24         | 
| .zero.table          |  0x1000f67c   |  8          | 
| .data                |  0x080022e0   |  1688       | 
| .cy_sharedmem        |  0x08002978   |  8          | 
| .noinit              |  0x08002980   |  148        | 
| .bss                 |  0x08002a14   |  2136       | 
| .heap                |  0x08003270   |  1029520    | 
---------------------------------------------------- 
Total Internal Flash (Available)          2097152    
Total Internal Flash (Utilized)           64812      
Total Internal SRAM (Available)           1046528    
Total Internal SRAM (Utilized with heap)  1033500    
Programming target device... 
Open On-Chip Debugger 0.10.0+dev-4.1.0.1058 (2020-08-11-03:45)
Licensed under GNU GPL v2
For bug reports, read
http://openocd.org/doc/doxygen/bugs.html
Info : auto-selecting first available session transport "swd". To override use 'transport select <transport>'.
adapter speed: 2000 kHz
adapter srst delay: 25
adapter srst pulse_width: 25
** Auto-acquire enabled, use "set ENABLE_ACQUIRE 0" to disable
cortex_m reset_config sysresetreq
cortex_m reset_config sysresetreq
Info : Using CMSIS loader 'CY8C6xxA_SMIF' for bank 'psoc6_smif0_cm0' (footprint 14672 bytes)
Warn : SFlash programming allowed for regions: USER, TOC, KEY
Info : CMSIS-DAP: SWD  Supported
Info : CMSIS-DAP: FW Version = 2.0.0
Info : CMSIS-DAP: Interface Initialised (SWD)
Info : SWCLK/TCK = 1 SWDIO/TMS = 1 TDI = 0 TDO = 0 nTRST = 0 nRESET = 1
Info : CMSIS-DAP: Interface ready
Info : KitProg3: FW version: 1.14.514
Info : KitProg3: Pipelined transfers disabled, please update the firmware
Info : VTarget = 3.220 V
Info : kitprog3: acquiring the device...
Info : clock speed 2000 kHz
Info : SWD DPIDR 0x6ba02477
Info : psoc6.cpu.cm0: hardware has 4 breakpoints, 2 watchpoints
***************************************
** Silicon: 0xE453, Family: 0x102, Rev.: 0x12 (A1)
** Detected Device: CY8C624ABZI-S2D44
** Detected Main Flash size, kb: 2048
** Flash Boot version: 3.1.0.378
** Chip Protection: NORMAL
***************************************
Info : psoc6.cpu.cm4: hardware has 6 breakpoints, 4 watchpoints
Info : starting gdb server for psoc6.cpu.cm0 on 3333
Info : Listening on port 3333 for gdb connections
Info : starting gdb server for psoc6.cpu.cm4 on 3334
Info : Listening on port 3334 for gdb connections
Info : SWD DPIDR 0x6ba02477
Info : kitprog3: acquiring the device...
psoc6.cpu.cm0 halted due to debug-request, current mode: Thread 
xPSR: 0x41000000 pc: 0x00000190 msp: 0x080ff800
** Device acquired successfully
** psoc6.cpu.cm4: Ran after reset and before halt...
psoc6.cpu.cm4 halted due to debug-request, current mode: Thread 
xPSR: 0x01000000 pc: 0x0000012a msp: 0x080ff800
** Programming Started **
auto erase enabled
Info : Flash write discontinued at 0x1000179c, next section at 0x10002000
Info : Padding image section 0 at 0x1000179c with 100 bytes (bank write end alignment)
[100%] [################################] [ Erasing     ]
[100%] [################################] [ Programming ]
Info : Padding image section 1 at 0x1000fd24 with 220 bytes (bank write end alignment)
[100%] [################################] [ Erasing     ]
[100%] [################################] [ Programming ]
wrote 62976 bytes from file /Users/arh/mtb22/IoT_Expert_FreeRTOS_NTShell_Template/build/CY8CKIT-062S2-43012/Debug/MTBShellTemplate.hex in 2.092903s (29.385 KiB/s)
** Programming Finished **
** Verify Started **
verified 62656 bytes in 0.123619s (494.968 KiB/s)
** Verified OK **
** Resetting Target **
Info : SWD DPIDR 0x6ba02477
shutdown command invoked
Info : psoc6.dap: powering down debug domain...

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

arh (master *) IoT_Expert_FreeRTOS_NTShell_Template $ make -j program

Tools Directory: /Applications/ModusToolbox/tools_2.2

CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk

Prebuild operations complete

Commencing build operations...

Tools Directory: /Applications/ModusToolbox/tools_2.2

CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk

Initializing build: MTBShellTemplate Debug CY8CKIT-062S2-43012 GCC_ARM

Auto-discovery in progress...

-> Found 205 .c file(s)

-> Found 46 .S file(s)

-> Found 23 .s file(s)

-> Found 0 .cpp file(s)

-> Found 0 .o file(s)

-> Found 6 .a file(s)

-> Found 503 .h file(s)

-> Found 0 .hpp file(s)

-> Found 0 resource file(s)

Applying filters...

Auto-discovery complete

Constructing build rules...

Build rules construction complete

==============================================================================

= Building application =

==============================================================================

Generating compilation database file...

-> ./build/compile_commands.json

Compilation database file generation complete

Building 193 file(s)

Compiling app file lowPower.c

Compiling app file main.c

Compiling app file usrcmd.c

Compiling ext file croutine.c

Compiling ext file event_groups.c

Compiling ext file list.c

Compiling ext file heap_1.c

Compiling ext file heap_2.c

Compiling ext file heap_3.c

Compiling ext file heap_4.c

Compiling ext file heap_5.c

Compiling ext file port.c

Compiling ext file queue.c

Compiling ext file stream_buffer.c

Compiling ext file tasks.c

Compiling ext file timers.c

Compiling ext file psoc6_ntshell_port.c

Linking output file MTBShellTemplate.elf

==============================================================================

= Build complete =

==============================================================================

Calculating memory consumption: CY8C624ABZI-S2D44 GCC_ARM -Og

----------------------------------------------------

| Section Name | Address | Size |

----------------------------------------------------

| .cy_m0p_image | 0x10000000 | 6044 |

| .text | 0x10002000 | 54876 |

| .ARM.exidx | 0x1000f65c | 8 |

| .copy.table | 0x1000f664 | 24 |

| .zero.table | 0x1000f67c | 8 |

| .data | 0x080022e0 | 1688 |

| .cy_sharedmem | 0x08002978 | 8 |

| .noinit | 0x08002980 | 148 |

| .bss | 0x08002a14 | 2136 |

| .heap | 0x08003270 | 1029520 |

----------------------------------------------------

Total Internal Flash (Available) 2097152

Total Internal Flash (Utilized) 64812

Total Internal SRAM (Available) 1046528

Total Internal SRAM (Utilized with heap) 1033500

Programming target device...

Open On-Chip Debugger 0.10.0+dev-4.1.0.1058 (2020-08-11-03:45)

Licensed under GNU GPL v2

For bug reports, read

http://openocd.org/doc/doxygen/bugs.html

Info : auto-selecting first available session transport "swd". To override use 'transport select <transport>'.

adapter speed: 2000 kHz

adapter srst delay: 25

adapter srst pulse_width: 25

** Auto-acquire enabled, use "set ENABLE_ACQUIRE 0" to disable

cortex_m reset_config sysresetreq

Info : Using CMSIS loader 'CY8C6xxA_SMIF' for bank 'psoc6_smif0_cm0' (footprint 14672 bytes)

Warn : SFlash programming allowed for regions: USER, TOC, KEY

Info : CMSIS-DAP: SWD Supported

Info : CMSIS-DAP: FW Version = 2.0.0

Info : CMSIS-DAP: Interface Initialised (SWD)

Info : SWCLK/TCK = 1 SWDIO/TMS = 1 TDI = 0 TDO = 0 nTRST = 0 nRESET = 1

Info : CMSIS-DAP: Interface ready

Info : KitProg3: FW version: 1.14.514

Info : KitProg3: Pipelined transfers disabled, please update the firmware

Info : VTarget = 3.220 V

Info : kitprog3: acquiring the device...

Info : clock speed 2000 kHz

Info : SWD DPIDR 0x6ba02477

Info : psoc6.cpu.cm0: hardware has 4 breakpoints, 2 watchpoints

***************************************

** Silicon: 0xE453, Family: 0x102, Rev.: 0x12 (A1)

** Detected Device: CY8C624ABZI-S2D44

** Detected Main Flash size, kb: 2048

** Flash Boot version: 3.1.0.378

** Chip Protection: NORMAL

***************************************

Info : psoc6.cpu.cm4: hardware has 6 breakpoints, 4 watchpoints

Info : starting gdb server for psoc6.cpu.cm0 on 3333

Info : Listening on port 3333 for gdb connections

Info : starting gdb server for psoc6.cpu.cm4 on 3334

Info : Listening on port 3334 for gdb connections

Info : SWD DPIDR 0x6ba02477

Info : kitprog3: acquiring the device...

psoc6.cpu.cm0 halted due to debug-request, current mode: Thread

xPSR: 0x41000000 pc: 0x00000190 msp: 0x080ff800

** Device acquired successfully

** psoc6.cpu.cm4: Ran after reset and before halt...

psoc6.cpu.cm4 halted due to debug-request, current mode: Thread

xPSR: 0x01000000 pc: 0x0000012a msp: 0x080ff800

** Programming Started **

auto erase enabled

Info : Flash write discontinued at 0x1000179c, next section at 0x10002000

Info : Padding image section 0 at 0x1000179c with 100 bytes (bank write end alignment)

[100%] [################################] [ Erasing ]

[100%] [################################] [ Programming ]

Info : Padding image section 1 at 0x1000fd24 with 220 bytes (bank write end alignment)

[100%] [################################] [ Erasing ]

[100%] [################################] [ Programming ]

wrote 62976 bytes from file /Users/arh/mtb22/IoT_Expert_FreeRTOS_NTShell_Template/build/CY8CKIT-062S2-43012/Debug/MTBShellTemplate.hex in 2.092903s (29.385 KiB/s)

** Programming Finished **

** Verify Started **

verified 62656 bytes in 0.123619s (494.968 KiB/s)

** Verified OK **

** Resetting Target **

Info : SWD DPIDR 0x6ba02477

shutdown command invoked

Info : psoc6.dap: powering down debug domain...

When I run help you can see I have a new command called “tasks” which lists all of the tasks and their stack high water marks.

Put the Template on GitHub

I am happy with my new template. So, I go to GitHub and create a new repository.

Then on my current project:

I blow away the git history (didnt really have to do that).
Create a new git repo “git init .”
Add a pointer to GitHub “git remote add….”
Add all of the files “git add *”
Add the .gitignore “git add .gitignore”
Commit the changes “git commit…”
Push it to GitHub “git push …”

arh (master *) IoT_Expert_FreeRTOS_NTShell_Template $ rm -rf .git
arh IoT_Expert_FreeRTOS_NTShell_Template $ git init .
Initialized empty Git repository in /Users/arh/mtb22/IoT_Expert_FreeRTOS_NTShell_Template/.git/
arh (master #) IoT_Expert_FreeRTOS_NTShell_Template $ git remote add origin git@iotexpert.github.com:iotexpert/mtb2-freertos-ntshell-template.git
arh (master #) IoT_Expert_FreeRTOS_NTShell_Template $ git add * 
The following paths are ignored by one of your .gitignore files:
build
Use -f if you really want to add them.
arh (master #) IoT_Expert_FreeRTOS_NTShell_Template $ git add .gitignore
arh (master #) IoT_Expert_FreeRTOS_NTShell_Template $ git status
On branch master
No commits yet
Changes to be committed:
(use "git rm --cached <file>..." to unstage)
new file:   .gitignore
new file:   FreeRTOSConfig.h
new file:   LICENSE
new file:   MTBShellTemplate.code-workspace
new file:   Makefile
new file:   README.md
new file:   deps/TARGET_CY8CKIT-062S2-43012.mtb
new file:   deps/freertos.mtb
new file:   deps/middleware-ntshell.mtb
new file:   deps/retarget-io.mtb
new file:   global.h
new file:   lowPower.c
new file:   main.c
new file:   openocd.tcl
new file:   usrcmd.c
new file:   usrcmd.h
Untracked files:
(use "git add <file>..." to include in what will be committed)
.vscode/
arh (master #) IoT_Expert_FreeRTOS_NTShell_Template $ git commit -m "Initial commit"
[master (root-commit) 26b5d3c] Initial commit
16 files changed, 994 insertions(+)
create mode 100644 .gitignore
create mode 100644 FreeRTOSConfig.h
create mode 100644 LICENSE
create mode 100644 MTBShellTemplate.code-workspace
create mode 100644 Makefile
create mode 100644 README.md
create mode 100644 deps/TARGET_CY8CKIT-062S2-43012.mtb
create mode 100644 deps/freertos.mtb
create mode 100644 deps/middleware-ntshell.mtb
create mode 100644 deps/retarget-io.mtb
create mode 100644 global.h
create mode 100644 lowPower.c
create mode 100644 main.c
create mode 100644 openocd.tcl
create mode 100644 usrcmd.c
create mode 100644 usrcmd.h
arh (master) IoT_Expert_FreeRTOS_NTShell_Template $ git push -u origin master
Enumerating objects: 19, done.
Counting objects: 100% (19/19), done.
Delta compression using up to 12 threads
Compressing objects: 100% (19/19), done.
Writing objects: 100% (19/19), 16.21 KiB | 5.40 MiB/s, done.
Total 19 (delta 0), reused 0 (delta 0)
To iotexpert.github.com:iotexpert/mtb2-freertos-ntshell-template.git
* [new branch]      master -> master
Branch 'master' set up to track remote branch 'master' from 'origin'.
arh (master) IoT_Expert_FreeRTOS_NTShell_Template $

arh (master *) IoT_Expert_FreeRTOS_NTShell_Template $ rm -rf .git

arh IoT_Expert_FreeRTOS_NTShell_Template $ git init .

Initialized empty Git repository in /Users/arh/mtb22/IoT_Expert_FreeRTOS_NTShell_Template/.git/

arh (master #) IoT_Expert_FreeRTOS_NTShell_Template $ git remote add origin git@iotexpert.github.com:iotexpert/mtb2-freertos-ntshell-template.git

arh (master #) IoT_Expert_FreeRTOS_NTShell_Template $ git add *

The following paths are ignored by one of your .gitignore files:

build

Use -f if you really want to add them.

arh (master #) IoT_Expert_FreeRTOS_NTShell_Template $ git add .gitignore

arh (master #) IoT_Expert_FreeRTOS_NTShell_Template $ git status

On branch master

No commits yet

Changes to be committed:

(use "git rm --cached <file>..." to unstage)

new file: .gitignore

new file: FreeRTOSConfig.h

new file: LICENSE

new file: MTBShellTemplate.code-workspace

new file: Makefile

new file: README.md

new file: deps/TARGET_CY8CKIT-062S2-43012.mtb

new file: deps/freertos.mtb

new file: deps/middleware-ntshell.mtb

new file: deps/retarget-io.mtb

new file: global.h

new file: lowPower.c

new file: main.c

new file: openocd.tcl

new file: usrcmd.c

new file: usrcmd.h

Untracked files:

(use "git add <file>..." to include in what will be committed)

.vscode/

arh (master #) IoT_Expert_FreeRTOS_NTShell_Template $ git commit -m "Initial commit"

[master (root-commit) 26b5d3c] Initial commit

16 files changed, 994 insertions(+)

create mode 100644 .gitignore

create mode 100644 FreeRTOSConfig.h

create mode 100644 LICENSE

create mode 100644 MTBShellTemplate.code-workspace

create mode 100644 Makefile

create mode 100644 README.md

create mode 100644 deps/TARGET_CY8CKIT-062S2-43012.mtb

create mode 100644 deps/freertos.mtb

create mode 100644 deps/middleware-ntshell.mtb

create mode 100644 deps/retarget-io.mtb

create mode 100644 global.h

create mode 100644 lowPower.c

create mode 100644 main.c

create mode 100644 openocd.tcl

create mode 100644 usrcmd.c

create mode 100644 usrcmd.h

arh (master) IoT_Expert_FreeRTOS_NTShell_Template $ git push -u origin master

Enumerating objects: 19, done.

Counting objects: 100% (19/19), done.

Delta compression using up to 12 threads

Compressing objects: 100% (19/19), done.

Writing objects: 100% (19/19), 16.21 KiB | 5.40 MiB/s, done.

Total 19 (delta 0), reused 0 (delta 0)

To iotexpert.github.com:iotexpert/mtb2-freertos-ntshell-template.git

* [new branch] master -> master

Branch 'master' set up to track remote branch 'master' from 'origin'.

arh (master) IoT_Expert_FreeRTOS_NTShell_Template $

Update the Manifests

To get access to the new template I need to add it to the IoT Expert App Manifest. I edit the xml file to have the new app

<apps>
<app>
<name>IoT Expert FreeRTOS Template</name>
<id>mtb2-freertos-template</id>
<uri>https://github.com/iotexpert/mtb2-freertos-template</uri>
<description>This template provide a starting point for FreeRTOS projects.  Including a starting blinking LED task</description>
<req_capabilities>psoc6</req_capabilities>
<versions>
<version>
<num>Latest 1.X release</num>
<commit>master</commit>
</version>
</versions>
</app>
<app>
<name>IoT Expert FreeRTOS NTShell Template</name>
<id>mtb2-freertos-ntshell-template</id>
<uri>https://github.com/iotexpert/mtb2-freertos-ntshell-template</uri>
<description>This template provide a starting point for FreeRTOS projects.  Including a starting blinking LED task and shell</description>
<req_capabilities>psoc6</req_capabilities>
<versions>
<version>
<num>Latest 1.X release</num>
<commit>master</commit>
</version>
</versions>
</app>
</apps>

<apps>

<app>

<name>IoT Expert FreeRTOS Template</name>

<id>mtb2-freertos-template</id>

<uri>https://github.com/iotexpert/mtb2-freertos-template</uri>

<description>This template provide a starting point for FreeRTOS projects. Including a starting blinking LED task</description>

<req_capabilities>psoc6</req_capabilities>

<num>Latest 1.X release</num>

<commit>master</commit>

</version>

</versions>

</app>

<app>

<name>IoT Expert FreeRTOS NTShell Template</name>

<id>mtb2-freertos-ntshell-template</id>

<uri>https://github.com/iotexpert/mtb2-freertos-ntshell-template</uri>

<description>This template provide a starting point for FreeRTOS projects. Including a starting blinking LED task and shell</description>

<req_capabilities>psoc6</req_capabilities>

<num>Latest 1.X release</num>

<commit>master</commit>

</version>

</versions>

</app>

</apps>

Now I need to git add, git commit and git push it to GitHub.

arh (master) mtb2-iotexpert-manifests $ code .
arh (master) mtb2-iotexpert-manifests $ git status
On branch master
Your branch is up to date with 'origin/master'.
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
modified:   iotexpert-app-manifest.xml
no changes added to commit (use "git add" and/or "git commit -a")
arh (master *) mtb2-iotexpert-manifests $ git add iotexpert-app-manifest.xml
arh (master +) mtb2-iotexpert-manifests $ git commit -m "Updated with ntshell example"
[master 47a7bb1] Updated with ntshell example
1 file changed, 13 insertions(+)
arh (master) mtb2-iotexpert-manifests $ git push
Enumerating objects: 5, done.
Counting objects: 100% (5/5), done.
Delta compression using up to 12 threads
Compressing objects: 100% (3/3), done.
Writing objects: 100% (3/3), 554 bytes | 554.00 KiB/s, done.
Total 3 (delta 1), reused 0 (delta 0)
remote: Resolving deltas: 100% (1/1), completed with 1 local object.
To iotexpert.github.com:iotexpert/mtb2-iotexpert-manifests.git
28ed2d0..47a7bb1  master -> master

arh (master) mtb2-iotexpert-manifests $ code .

arh (master) mtb2-iotexpert-manifests $ git status

On branch master

Your branch is up to date with 'origin/master'.

Changes not staged for commit:

(use "git add <file>..." to update what will be committed)

(use "git restore <file>..." to discard changes in working directory)

modified: iotexpert-app-manifest.xml

no changes added to commit (use "git add" and/or "git commit -a")

arh (master *) mtb2-iotexpert-manifests $ git add iotexpert-app-manifest.xml

arh (master +) mtb2-iotexpert-manifests $ git commit -m "Updated with ntshell example"

[master 47a7bb1] Updated with ntshell example

1 file changed, 13 insertions(+)

arh (master) mtb2-iotexpert-manifests $ git push

Enumerating objects: 5, done.

Counting objects: 100% (5/5), done.

Delta compression using up to 12 threads

Compressing objects: 100% (3/3), done.

Writing objects: 100% (3/3), 554 bytes | 554.00 KiB/s, done.

Total 3 (delta 1), reused 0 (delta 0)

remote: Resolving deltas: 100% (1/1), completed with 1 local object.

To iotexpert.github.com:iotexpert/mtb2-iotexpert-manifests.git

28ed2d0..47a7bb1 master -> master

Test the new Template

Everything should be working so make a new project.

Cool. There is the new template.

When I program it… everything is cool.

arh (master) TestNTS $ make -j program
Tools Directory: /Applications/ModusToolbox/tools_2.2
CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk
Prebuild operations complete
Commencing build operations...
Tools Directory: /Applications/ModusToolbox/tools_2.2
CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk
Initializing build: MTBShellTemplate Debug CY8CKIT-062S2-43012 GCC_ARM
Auto-discovery in progress...
-> Found 205 .c file(s)
-> Found 46 .S file(s)
-> Found 23 .s file(s)
-> Found 0 .cpp file(s)
-> Found 0 .o file(s)
-> Found 6 .a file(s)
-> Found 503 .h file(s)
-> Found 0 .hpp file(s)
-> Found 0 resource file(s)
Applying filters...
Auto-discovery complete
Constructing build rules...
Build rules construction complete
==============================================================================
= Building application =
==============================================================================
Generating compilation database file...
-> ./build/compile_commands.json
Compilation database file generation complete
Building 193 file(s)
Compiling app file lowPower.c
Compiling app file main.c
Compiling app file usrcmd.c
Compiling ext file startup_psoc6_02_cm4.S
Compiling ext file cy_syslib_gcc.S
Compiling ext file cycfg.c
Compiling ext file cycfg_capsense.c
Compiling ext file cycfg_clocks.c
Compiling ext file cycfg_peripherals.c
Compiling ext file cycfg_pins.c
Compiling ext file cycfg_qspi_memslot.c
Compiling ext file cycfg_routing.c
Compiling ext file cycfg_system.c
Compiling ext file system_psoc6_cm4.c
Compiling ext file cybsp.c
Compiling ext file cy_capsense_centroid.c
Compiling ext file cy_capsense_control.c
Compiling ext file cy_capsense_csd.c
Compiling ext file cy_capsense_csx.c
Compiling ext file cy_capsense_filter.c
Compiling ext file cy_capsense_processing.c
Compiling ext file cy_capsense_selftest.c
Compiling ext file cy_capsense_sensing.c
Compiling ext file cy_capsense_structure.c
Compiling ext file cy_capsense_tuner.c
Compiling ext file croutine.c
Compiling ext file event_groups.c
Compiling ext file list.c
Compiling ext file heap_1.c
Compiling ext file heap_2.c
Compiling ext file heap_3.c
Compiling ext file heap_4.c
Compiling ext file heap_5.c
Compiling ext file port.c
Compiling ext file queue.c
Compiling ext file stream_buffer.c
Compiling ext file tasks.c
Compiling ext file timers.c
Compiling ext file ntlibc.c
Compiling ext file ntshell.c
Compiling ext file text_editor.c
Compiling ext file text_history.c
Compiling ext file vtrecv.c
Compiling ext file vtsend.c
Compiling ext file psoc6_ntshell_port.c
Compiling ext file ntopt.c
Compiling ext file ntstdio.c
Compiling ext file cyhal_adc.c
Compiling ext file cyhal_analog_common.c
Compiling ext file cyhal_clock.c
Compiling ext file cyhal_comp.c
Compiling ext file cyhal_comp_ctb.c
Compiling ext file cyhal_comp_lp.c
Compiling ext file cyhal_crc.c
Compiling ext file cyhal_crypto_common.c
Compiling ext file cyhal_dac.c
Compiling ext file cyhal_deprecated.c
Compiling ext file cyhal_dma.c
Compiling ext file cyhal_dma_dmac.c
Compiling ext file cyhal_dma_dw.c
Compiling ext file cyhal_ezi2c.c
Compiling ext file cyhal_flash.c
Compiling ext file cyhal_gpio.c
Compiling ext file cyhal_hwmgr.c
Compiling ext file cyhal_i2c.c
Compiling ext file cyhal_i2s.c
Compiling ext file cyhal_interconnect.c
Compiling ext file cyhal_lptimer.c
Compiling ext file cyhal_not_implemented.c
Compiling ext file cyhal_opamp.c
Compiling ext file cyhal_pdmpcm.c
Compiling ext file cyhal_pwm.c
Compiling ext file cyhal_qspi.c
Compiling ext file cyhal_rtc.c
Compiling ext file cyhal_scb_common.c
Compiling ext file cyhal_sdhc.c
Compiling ext file cyhal_spi.c
Compiling ext file cyhal_syspm.c
Compiling ext file cyhal_system.c
Compiling ext file cyhal_tcpwm_common.c
Compiling ext file cyhal_timer.c
Compiling ext file cyhal_trng.c
Compiling ext file cyhal_uart.c
Compiling ext file cyhal_udb_sdio.c
Compiling ext file cyhal_usb_dev.c
Compiling ext file cyhal_utils.c
Compiling ext file cyhal_wdt.c
Compiling ext file cyhal_psoc6_01_104_m_csp_ble.c
Compiling ext file cyhal_psoc6_01_104_m_csp_ble_usb.c
Compiling ext file cyhal_psoc6_01_116_bga_ble.c
Compiling ext file cyhal_psoc6_01_116_bga_usb.c
Compiling ext file cyhal_psoc6_01_124_bga.c
Compiling ext file cyhal_psoc6_01_124_bga_sip.c
Compiling ext file cyhal_psoc6_01_43_smt.c
Compiling ext file cyhal_psoc6_01_68_qfn_ble.c
Compiling ext file cyhal_psoc6_01_80_wlcsp.c
Compiling ext file cyhal_psoc6_02_100_wlcsp.c
Compiling ext file cyhal_psoc6_02_124_bga.c
Compiling ext file cyhal_psoc6_02_128_tqfp.c
Compiling ext file cyhal_psoc6_02_68_qfn.c
Compiling ext file cyhal_psoc6_03_100_tqfp.c
Compiling ext file cyhal_psoc6_03_49_wlcsp.c
Compiling ext file cyhal_psoc6_03_68_qfn.c
Compiling ext file cyhal_psoc6_04_64_tqfp.c
Compiling ext file cyhal_psoc6_04_68_qfn.c
Compiling ext file cyhal_psoc6_04_80_tqfp.c
Compiling ext file cyhal_triggers_psoc6_01.c
Compiling ext file cyhal_triggers_psoc6_02.c
Compiling ext file cyhal_triggers_psoc6_03.c
Compiling ext file cyhal_triggers_psoc6_04.c
Compiling ext file cy_ble_clk.c
Compiling ext file cy_canfd.c
Compiling ext file cy_crypto.c
Compiling ext file cy_crypto_core_aes_v1.c
Compiling ext file cy_crypto_core_aes_v2.c
Compiling ext file cy_crypto_core_cmac_v1.c
Compiling ext file cy_crypto_core_cmac_v2.c
Compiling ext file cy_crypto_core_crc_v1.c
Compiling ext file cy_crypto_core_crc_v2.c
Compiling ext file cy_crypto_core_des_v1.c
Compiling ext file cy_crypto_core_des_v2.c
Compiling ext file cy_crypto_core_ecc_domain_params.c
Compiling ext file cy_crypto_core_ecc_ecdsa.c
Compiling ext file cy_crypto_core_ecc_key_gen.c
Compiling ext file cy_crypto_core_ecc_nist_p.c
Compiling ext file cy_crypto_core_hmac_v1.c
Compiling ext file cy_crypto_core_hmac_v2.c
Compiling ext file cy_crypto_core_hw.c
Compiling ext file cy_crypto_core_hw_v1.c
Compiling ext file cy_crypto_core_mem_v1.c
Compiling ext file cy_crypto_core_mem_v2.c
Compiling ext file cy_crypto_core_prng_v1.c
Compiling ext file cy_crypto_core_prng_v2.c
Compiling ext file cy_crypto_core_rsa.c
Compiling ext file cy_crypto_core_sha_v1.c
Compiling ext file cy_crypto_core_sha_v2.c
Compiling ext file cy_crypto_core_trng_v1.c
Compiling ext file cy_crypto_core_trng_v2.c
Compiling ext file cy_crypto_core_vu.c
Compiling ext file cy_crypto_server.c
Compiling ext file cy_csd.c
Compiling ext file cy_ctb.c
Compiling ext file cy_ctdac.c
Compiling ext file cy_device.c
Compiling ext file cy_dma.c
Compiling ext file cy_dmac.c
Compiling ext file cy_efuse.c
Compiling ext file cy_flash.c
Compiling ext file cy_gpio.c
Compiling ext file cy_i2s.c
Compiling ext file cy_ipc_drv.c
Compiling ext file cy_ipc_pipe.c
Compiling ext file cy_ipc_sema.c
Compiling ext file cy_lpcomp.c
Compiling ext file cy_lvd.c
Compiling ext file cy_mcwdt.c
Compiling ext file cy_pdm_pcm.c
Compiling ext file cy_pra.c
Compiling ext file cy_pra_cfg.c
Compiling ext file cy_profile.c
Compiling ext file cy_prot.c
Compiling ext file cy_rtc.c
Compiling ext file cy_sar.c
Compiling ext file cy_scb_common.c
Compiling ext file cy_scb_ezi2c.c
Compiling ext file cy_scb_i2c.c
Compiling ext file cy_scb_spi.c
Compiling ext file cy_scb_uart.c
Compiling ext file cy_sd_host.c
Compiling ext file cy_seglcd.c
Compiling ext file cy_smartio.c
Compiling ext file cy_smif.c
Compiling ext file cy_smif_memslot.c
Compiling ext file cy_sysanalog.c
Compiling ext file cy_sysclk.c
Compiling ext file cy_sysint.c
Compiling ext file cy_syslib.c
Compiling ext file cy_syspm.c
Compiling ext file cy_systick.c
Compiling ext file cy_tcpwm_counter.c
Compiling ext file cy_tcpwm_pwm.c
Compiling ext file cy_tcpwm_quaddec.c
Compiling ext file cy_tcpwm_shiftreg.c
Compiling ext file cy_trigmux.c
Compiling ext file cy_usbfs_dev_drv.c
Compiling ext file cy_usbfs_dev_drv_io.c
Compiling ext file cy_usbfs_dev_drv_io_dma.c
Compiling ext file cy_wdt.c
Compiling ext file psoc6_01_cm0p_sleep.c
Compiling ext file psoc6_02_cm0p_sleep.c
Compiling ext file psoc6_03_cm0p_sleep.c
Compiling ext file psoc6_04_cm0p_sleep.c
Compiling ext file cy_retarget_io.c
Linking output file MTBShellTemplate.elf
==============================================================================
= Build complete =
==============================================================================
Calculating memory consumption: CY8C624ABZI-S2D44 GCC_ARM -Og
---------------------------------------------------- 
| Section Name         |  Address      |  Size       | 
---------------------------------------------------- 
| .cy_m0p_image        |  0x10000000   |  6044       | 
| .text                |  0x10002000   |  54876      | 
| .ARM.exidx           |  0x1000f65c   |  8          | 
| .copy.table          |  0x1000f664   |  24         | 
| .zero.table          |  0x1000f67c   |  8          | 
| .data                |  0x080022e0   |  1688       | 
| .cy_sharedmem        |  0x08002978   |  8          | 
| .noinit              |  0x08002980   |  148        | 
| .bss                 |  0x08002a14   |  2136       | 
| .heap                |  0x08003270   |  1029520    | 
---------------------------------------------------- 
Total Internal Flash (Available)          2097152    
Total Internal Flash (Utilized)           64812      
Total Internal SRAM (Available)           1046528    
Total Internal SRAM (Utilized with heap)  1033500    
Programming target device... 
Open On-Chip Debugger 0.10.0+dev-4.1.0.1058 (2020-08-11-03:45)
Licensed under GNU GPL v2
For bug reports, read
http://openocd.org/doc/doxygen/bugs.html
Info : auto-selecting first available session transport "swd". To override use 'transport select <transport>'.
adapter speed: 2000 kHz
adapter srst delay: 25
adapter srst pulse_width: 25
** Auto-acquire enabled, use "set ENABLE_ACQUIRE 0" to disable
cortex_m reset_config sysresetreq
cortex_m reset_config sysresetreq
Info : Using CMSIS loader 'CY8C6xxA_SMIF' for bank 'psoc6_smif0_cm0' (footprint 14672 bytes)
Warn : SFlash programming allowed for regions: USER, TOC, KEY
Info : CMSIS-DAP: SWD  Supported
Info : CMSIS-DAP: FW Version = 2.0.0
Info : CMSIS-DAP: Interface Initialised (SWD)
Info : SWCLK/TCK = 1 SWDIO/TMS = 1 TDI = 0 TDO = 0 nTRST = 0 nRESET = 1
Info : CMSIS-DAP: Interface ready
Info : KitProg3: FW version: 1.14.514
Info : KitProg3: Pipelined transfers disabled, please update the firmware
Info : VTarget = 3.221 V
Info : kitprog3: acquiring the device...
Info : clock speed 2000 kHz
Info : SWD DPIDR 0x6ba02477
Info : psoc6.cpu.cm0: hardware has 4 breakpoints, 2 watchpoints
***************************************
** Silicon: 0xE453, Family: 0x102, Rev.: 0x12 (A1)
** Detected Device: CY8C624ABZI-S2D44
** Detected Main Flash size, kb: 2048
** Flash Boot version: 3.1.0.378
** Chip Protection: NORMAL
***************************************
Info : psoc6.cpu.cm4: hardware has 6 breakpoints, 4 watchpoints
Info : starting gdb server for psoc6.cpu.cm0 on 3333
Info : Listening on port 3333 for gdb connections
Info : starting gdb server for psoc6.cpu.cm4 on 3334
Info : Listening on port 3334 for gdb connections
Info : SWD DPIDR 0x6ba02477
Info : kitprog3: acquiring the device...
psoc6.cpu.cm0 halted due to debug-request, current mode: Thread 
xPSR: 0x41000000 pc: 0x00000190 msp: 0x080ff800
** Device acquired successfully
** psoc6.cpu.cm4: Ran after reset and before halt...
psoc6.cpu.cm4 halted due to debug-request, current mode: Thread 
xPSR: 0x01000000 pc: 0x0000012a msp: 0x080ff800
** Programming Started **
auto erase enabled
Info : Flash write discontinued at 0x1000179c, next section at 0x10002000
Info : Padding image section 0 at 0x1000179c with 100 bytes (bank write end alignment)
[100%] [################################] [ Erasing     ]
[100%] [################################] [ Programming ]
Info : Padding image section 1 at 0x1000fd24 with 220 bytes (bank write end alignment)
[100%] [################################] [ Erasing     ]
[100%] [################################] [ Programming ]
wrote 62976 bytes from file /Users/arh/mtb22/TestNTS/build/CY8CKIT-062S2-43012/Debug/MTBShellTemplate.hex in 2.082329s (29.534 KiB/s)
** Programming Finished **
** Verify Started **
verified 62656 bytes in 0.122516s (499.425 KiB/s)
** Verified OK **
** Resetting Target **
Info : SWD DPIDR 0x6ba02477
shutdown command invoked
Info : psoc6.dap: powering down debug domain...
arh (master) TestNTS $

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

arh (master) TestNTS $ make -j program

Tools Directory: /Applications/ModusToolbox/tools_2.2

CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk

Prebuild operations complete

Commencing build operations...

Tools Directory: /Applications/ModusToolbox/tools_2.2

CY8CKIT-062S2-43012.mk: ../mtb_shared/TARGET_CY8CKIT-062S2-43012/latest-v2.X/CY8CKIT-062S2-43012.mk

Initializing build: MTBShellTemplate Debug CY8CKIT-062S2-43012 GCC_ARM

Auto-discovery in progress...

-> Found 205 .c file(s)

-> Found 46 .S file(s)

-> Found 23 .s file(s)

-> Found 0 .cpp file(s)

-> Found 0 .o file(s)

-> Found 6 .a file(s)

-> Found 503 .h file(s)

-> Found 0 .hpp file(s)

-> Found 0 resource file(s)

Applying filters...

Auto-discovery complete

Constructing build rules...

Build rules construction complete

==============================================================================

= Building application =

==============================================================================

Generating compilation database file...

-> ./build/compile_commands.json

Compilation database file generation complete

Building 193 file(s)

Compiling app file lowPower.c

Compiling app file main.c

Compiling app file usrcmd.c

Compiling ext file startup_psoc6_02_cm4.S

Compiling ext file cy_syslib_gcc.S

Compiling ext file cycfg.c

Compiling ext file cycfg_capsense.c

Compiling ext file cycfg_clocks.c

Compiling ext file cycfg_peripherals.c

Compiling ext file cycfg_pins.c

Compiling ext file cycfg_qspi_memslot.c

Compiling ext file cycfg_routing.c

Compiling ext file cycfg_system.c

Compiling ext file system_psoc6_cm4.c

Compiling ext file cybsp.c

Compiling ext file cy_capsense_centroid.c

Compiling ext file cy_capsense_control.c

Compiling ext file cy_capsense_csd.c

Compiling ext file cy_capsense_csx.c

Compiling ext file cy_capsense_filter.c

Compiling ext file cy_capsense_processing.c

Compiling ext file cy_capsense_selftest.c

Compiling ext file cy_capsense_sensing.c

Compiling ext file cy_capsense_structure.c

Compiling ext file cy_capsense_tuner.c

Compiling ext file croutine.c

Compiling ext file event_groups.c

Compiling ext file list.c

Compiling ext file heap_1.c

Compiling ext file heap_2.c

Compiling ext file heap_3.c

Compiling ext file heap_4.c

Compiling ext file heap_5.c

Compiling ext file port.c

Compiling ext file queue.c

Compiling ext file stream_buffer.c

Compiling ext file tasks.c

Compiling ext file timers.c

Compiling ext file ntlibc.c

Compiling ext file ntshell.c

Compiling ext file text_editor.c

Compiling ext file text_history.c

Compiling ext file vtrecv.c

Compiling ext file vtsend.c

Compiling ext file psoc6_ntshell_port.c

Compiling ext file ntopt.c

Compiling ext file ntstdio.c

Compiling ext file cyhal_adc.c

Compiling ext file cyhal_analog_common.c

Compiling ext file cyhal_clock.c

Compiling ext file cyhal_comp.c

Compiling ext file cyhal_comp_ctb.c

Compiling ext file cyhal_comp_lp.c

Compiling ext file cyhal_crc.c

Compiling ext file cyhal_crypto_common.c

Compiling ext file cyhal_dac.c

Compiling ext file cyhal_deprecated.c

Compiling ext file cyhal_dma.c

Compiling ext file cyhal_dma_dmac.c

Compiling ext file cyhal_dma_dw.c

Compiling ext file cyhal_ezi2c.c

Compiling ext file cyhal_flash.c

Compiling ext file cyhal_gpio.c

Compiling ext file cyhal_hwmgr.c

Compiling ext file cyhal_i2c.c

Compiling ext file cyhal_i2s.c

Compiling ext file cyhal_interconnect.c

Compiling ext file cyhal_lptimer.c

Compiling ext file cyhal_not_implemented.c

Compiling ext file cyhal_opamp.c

Compiling ext file cyhal_pdmpcm.c

Compiling ext file cyhal_pwm.c

Compiling ext file cyhal_qspi.c

Compiling ext file cyhal_rtc.c

Compiling ext file cyhal_scb_common.c

Compiling ext file cyhal_sdhc.c

Compiling ext file cyhal_spi.c

Compiling ext file cyhal_syspm.c

Compiling ext file cyhal_system.c

Compiling ext file cyhal_tcpwm_common.c

Compiling ext file cyhal_timer.c

Compiling ext file cyhal_trng.c

Compiling ext file cyhal_uart.c

Compiling ext file cyhal_udb_sdio.c

Compiling ext file cyhal_usb_dev.c

Compiling ext file cyhal_utils.c

Compiling ext file cyhal_wdt.c

Compiling ext file cyhal_psoc6_01_104_m_csp_ble.c

Compiling ext file cyhal_psoc6_01_104_m_csp_ble_usb.c

Compiling ext file cyhal_psoc6_01_116_bga_ble.c

Compiling ext file cyhal_psoc6_01_116_bga_usb.c

Compiling ext file cyhal_psoc6_01_124_bga.c

Compiling ext file cyhal_psoc6_01_124_bga_sip.c

Compiling ext file cyhal_psoc6_01_43_smt.c

Compiling ext file cyhal_psoc6_01_68_qfn_ble.c

Compiling ext file cyhal_psoc6_01_80_wlcsp.c

Compiling ext file cyhal_psoc6_02_100_wlcsp.c

Compiling ext file cyhal_psoc6_02_124_bga.c

Compiling ext file cyhal_psoc6_02_128_tqfp.c

Compiling ext file cyhal_psoc6_02_68_qfn.c

Compiling ext file cyhal_psoc6_03_100_tqfp.c

Compiling ext file cyhal_psoc6_03_49_wlcsp.c

Compiling ext file cyhal_psoc6_03_68_qfn.c

Compiling ext file cyhal_psoc6_04_64_tqfp.c

Compiling ext file cyhal_psoc6_04_68_qfn.c

Compiling ext file cyhal_psoc6_04_80_tqfp.c

Compiling ext file cyhal_triggers_psoc6_01.c

Compiling ext file cyhal_triggers_psoc6_02.c

Compiling ext file cyhal_triggers_psoc6_03.c

Compiling ext file cyhal_triggers_psoc6_04.c

Compiling ext file cy_ble_clk.c

Compiling ext file cy_canfd.c

Compiling ext file cy_crypto.c

Compiling ext file cy_crypto_core_aes_v1.c

Compiling ext file cy_crypto_core_aes_v2.c

Compiling ext file cy_crypto_core_cmac_v1.c

Compiling ext file cy_crypto_core_cmac_v2.c

Compiling ext file cy_crypto_core_crc_v1.c

Compiling ext file cy_crypto_core_crc_v2.c

Compiling ext file cy_crypto_core_des_v1.c

Compiling ext file cy_crypto_core_des_v2.c

Compiling ext file cy_crypto_core_ecc_domain_params.c

Compiling ext file cy_crypto_core_ecc_ecdsa.c

Compiling ext file cy_crypto_core_ecc_key_gen.c

Compiling ext file cy_crypto_core_ecc_nist_p.c

Compiling ext file cy_crypto_core_hmac_v1.c

Compiling ext file cy_crypto_core_hmac_v2.c

Compiling ext file cy_crypto_core_hw.c

Compiling ext file cy_crypto_core_hw_v1.c

Compiling ext file cy_crypto_core_mem_v1.c

Compiling ext file cy_crypto_core_mem_v2.c

Compiling ext file cy_crypto_core_prng_v1.c

Compiling ext file cy_crypto_core_prng_v2.c

Compiling ext file cy_crypto_core_rsa.c

Compiling ext file cy_crypto_core_sha_v1.c

Compiling ext file cy_crypto_core_sha_v2.c

Compiling ext file cy_crypto_core_trng_v1.c

Compiling ext file cy_crypto_core_trng_v2.c

Compiling ext file cy_crypto_core_vu.c

Compiling ext file cy_crypto_server.c

Compiling ext file cy_csd.c

Compiling ext file cy_ctb.c

Compiling ext file cy_ctdac.c

Compiling ext file cy_device.c

Compiling ext file cy_dma.c

Compiling ext file cy_dmac.c

Compiling ext file cy_efuse.c

Compiling ext file cy_flash.c

Compiling ext file cy_gpio.c

Compiling ext file cy_i2s.c

Compiling ext file cy_ipc_drv.c

Compiling ext file cy_ipc_pipe.c

Compiling ext file cy_ipc_sema.c

Compiling ext file cy_lpcomp.c

Compiling ext file cy_lvd.c

Compiling ext file cy_mcwdt.c

Compiling ext file cy_pdm_pcm.c

Compiling ext file cy_pra.c

Compiling ext file cy_pra_cfg.c

Compiling ext file cy_profile.c

Compiling ext file cy_prot.c

Compiling ext file cy_rtc.c

Compiling ext file cy_sar.c

Compiling ext file cy_scb_common.c

Compiling ext file cy_scb_ezi2c.c

Compiling ext file cy_scb_i2c.c

Compiling ext file cy_scb_spi.c

Compiling ext file cy_scb_uart.c

Compiling ext file cy_sd_host.c

Compiling ext file cy_seglcd.c

Compiling ext file cy_smartio.c

Compiling ext file cy_smif.c

Compiling ext file cy_smif_memslot.c

Compiling ext file cy_sysanalog.c

Compiling ext file cy_sysclk.c

Compiling ext file cy_sysint.c

Compiling ext file cy_syslib.c

Compiling ext file cy_syspm.c

Compiling ext file cy_systick.c

Compiling ext file cy_tcpwm_counter.c

Compiling ext file cy_tcpwm_pwm.c

Compiling ext file cy_tcpwm_quaddec.c

Compiling ext file cy_tcpwm_shiftreg.c

Compiling ext file cy_trigmux.c

Compiling ext file cy_usbfs_dev_drv.c

Compiling ext file cy_usbfs_dev_drv_io.c

Compiling ext file cy_usbfs_dev_drv_io_dma.c

Compiling ext file cy_wdt.c

Compiling ext file psoc6_01_cm0p_sleep.c

Compiling ext file psoc6_02_cm0p_sleep.c

Compiling ext file psoc6_03_cm0p_sleep.c

Compiling ext file psoc6_04_cm0p_sleep.c

Compiling ext file cy_retarget_io.c

Linking output file MTBShellTemplate.elf

==============================================================================

= Build complete =

==============================================================================

Calculating memory consumption: CY8C624ABZI-S2D44 GCC_ARM -Og

----------------------------------------------------

| Section Name | Address | Size |

----------------------------------------------------

| .cy_m0p_image | 0x10000000 | 6044 |

| .text | 0x10002000 | 54876 |

| .ARM.exidx | 0x1000f65c | 8 |

| .copy.table | 0x1000f664 | 24 |

| .zero.table | 0x1000f67c | 8 |

| .data | 0x080022e0 | 1688 |

| .cy_sharedmem | 0x08002978 | 8 |

| .noinit | 0x08002980 | 148 |

| .bss | 0x08002a14 | 2136 |

| .heap | 0x08003270 | 1029520 |

----------------------------------------------------

Total Internal Flash (Available) 2097152

Total Internal Flash (Utilized) 64812

Total Internal SRAM (Available) 1046528

Total Internal SRAM (Utilized with heap) 1033500

Programming target device...

Open On-Chip Debugger 0.10.0+dev-4.1.0.1058 (2020-08-11-03:45)

Licensed under GNU GPL v2

For bug reports, read

http://openocd.org/doc/doxygen/bugs.html

Info : auto-selecting first available session transport "swd". To override use 'transport select <transport>'.

adapter speed: 2000 kHz

adapter srst delay: 25

adapter srst pulse_width: 25

** Auto-acquire enabled, use "set ENABLE_ACQUIRE 0" to disable

cortex_m reset_config sysresetreq

Info : Using CMSIS loader 'CY8C6xxA_SMIF' for bank 'psoc6_smif0_cm0' (footprint 14672 bytes)

Warn : SFlash programming allowed for regions: USER, TOC, KEY

Info : CMSIS-DAP: SWD Supported

Info : CMSIS-DAP: FW Version = 2.0.0

Info : CMSIS-DAP: Interface Initialised (SWD)

Info : SWCLK/TCK = 1 SWDIO/TMS = 1 TDI = 0 TDO = 0 nTRST = 0 nRESET = 1

Info : CMSIS-DAP: Interface ready

Info : KitProg3: FW version: 1.14.514

Info : KitProg3: Pipelined transfers disabled, please update the firmware

Info : VTarget = 3.221 V

Info : kitprog3: acquiring the device...

Info : clock speed 2000 kHz

Info : SWD DPIDR 0x6ba02477

Info : psoc6.cpu.cm0: hardware has 4 breakpoints, 2 watchpoints

***************************************

** Silicon: 0xE453, Family: 0x102, Rev.: 0x12 (A1)

** Detected Device: CY8C624ABZI-S2D44

** Detected Main Flash size, kb: 2048

** Flash Boot version: 3.1.0.378

** Chip Protection: NORMAL

***************************************

Info : psoc6.cpu.cm4: hardware has 6 breakpoints, 4 watchpoints

Info : starting gdb server for psoc6.cpu.cm0 on 3333

Info : Listening on port 3333 for gdb connections

Info : starting gdb server for psoc6.cpu.cm4 on 3334

Info : Listening on port 3334 for gdb connections

Info : SWD DPIDR 0x6ba02477

Info : kitprog3: acquiring the device...

psoc6.cpu.cm0 halted due to debug-request, current mode: Thread

xPSR: 0x41000000 pc: 0x00000190 msp: 0x080ff800

** Device acquired successfully

** psoc6.cpu.cm4: Ran after reset and before halt...

psoc6.cpu.cm4 halted due to debug-request, current mode: Thread

xPSR: 0x01000000 pc: 0x0000012a msp: 0x080ff800

** Programming Started **

auto erase enabled

Info : Flash write discontinued at 0x1000179c, next section at 0x10002000

Info : Padding image section 0 at 0x1000179c with 100 bytes (bank write end alignment)

[100%] [################################] [ Erasing ]

[100%] [################################] [ Programming ]

Info : Padding image section 1 at 0x1000fd24 with 220 bytes (bank write end alignment)

[100%] [################################] [ Erasing ]

[100%] [################################] [ Programming ]

wrote 62976 bytes from file /Users/arh/mtb22/TestNTS/build/CY8CKIT-062S2-43012/Debug/MTBShellTemplate.hex in 2.082329s (29.534 KiB/s)

** Programming Finished **

** Verify Started **

verified 62656 bytes in 0.122516s (499.425 KiB/s)

** Verified OK **

** Resetting Target **

Info : SWD DPIDR 0x6ba02477

shutdown command invoked

Info : psoc6.dap: powering down debug domain...

arh (master) TestNTS $

And the project seems to be doing the needful.

PSoC 6 SDK OneWire Bus (Part 5): Round out the OWB driver

Summary

This article shows the completion of the PSoC 6 SDK One Wire Bus library. It shows the test apparatus for evaluating DS18B20 sensors.

Article
PSoC 6 SDK OneWire Bus (Part 1) : Build Basic Project
PSoC 6 SDK OneWire Bus (Part 2) : Implement Read & Write
PSoC 6 SDK OneWire Bus (Part 3) : Remove Busy Wait & Debug
PSoC 6 SDK OneWire Bus (Part 4): But, Can it Read the Temperature?
PSoC 6 SDK OneWire Bus (Part 5): Round out the OWB Driver

Story

If you remember from the previous articles, I created the one wire bus library by looking at the function calls in the DS18B20 library and reverse engineering the function prototypes. And, as I said in the earlier article, it would have been way better to just look at the David Antliff “OWB” library. But that is not how it went down. I wonder how much time in the world is wasted by programmer re-implementing code that already exists?

After the first four articles, I had three functions which the DS18B20 library defined, but I had not yet implemented.

owb_ret_t owb_write_rom_code(OneWireBus *bus, OneWireBus_ROMCode romcode);
owb_ret_t owb_crc8_bytes(uint32_t val, uint8_t *buffer, uint32_t length);
void   owb_set_strong_pullup( OneWireBus *bus, bool val);

owb_ret_t owb_write_rom_code(OneWireBus *bus, OneWireBus_ROMCode romcode);

owb_ret_t owb_crc8_bytes(uint32_t val, uint8_t *buffer, uint32_t length);

void owb_set_strong_pullup( OneWireBus *bus, bool val);

I had not implemented them because I was not totally sure how they worked. So, I decided to go back to GitHub and see what David had done originally. When I got to the GitHub site, https://github.com/DavidAntliff/esp32-owb/blob/master/include/owb.h, there were actually quite a few functions in his owb library that I had not implemented.

Here is the list:

owb_ret_t owb_use_crc(OneWireBus * bus, bool use_crc);
owb_ret_t owb_use_parasitic_power(OneWireBus * bus, bool use_parasitic_power);
owb_ret_t owb_use_strong_pullup_gpio(OneWireBus * bus, cyhal_gpio_t gpio);
owb_ret_t owb_read_rom(OneWireBus * bus, OneWireBus_ROMCode * rom_code);
owb_ret_t owb_verify_rom(OneWireBus * bus, OneWireBus_ROMCode *rom_code, bool * is_present);
owb_ret_t owb_write_rom_code(OneWireBus * bus, OneWireBus_ROMCode *rom_code);
uint8_t owb_crc8_byte(uint8_t crc, uint8_t data);
uint8_t owb_crc8_bytes(uint8_t crc, const uint8_t * data, size_t len);
owb_ret_t owb_search_first(OneWireBus * bus, OneWireBus_SearchState * state, bool *found_device);
owb_ret_t owb_search_next(OneWireBus * bus, OneWireBus_SearchState * state, bool *found_device);
char * owb_string_from_rom_code(OneWireBus_ROMCode *rom_code, char * buffer, size_t len);
owb_ret_t owb_set_strong_pullup(OneWireBus * bus, bool enable);

owb_ret_t owb_use_crc(OneWireBus * bus, bool use_crc);

owb_ret_t owb_use_parasitic_power(OneWireBus * bus, bool use_parasitic_power);

owb_ret_t owb_use_strong_pullup_gpio(OneWireBus * bus, cyhal_gpio_t gpio);

owb_ret_t owb_read_rom(OneWireBus * bus, OneWireBus_ROMCode * rom_code);

owb_ret_t owb_verify_rom(OneWireBus * bus, OneWireBus_ROMCode *rom_code, bool * is_present);

owb_ret_t owb_write_rom_code(OneWireBus * bus, OneWireBus_ROMCode *rom_code);

uint8_t owb_crc8_byte(uint8_t crc, uint8_t data);

uint8_t owb_crc8_bytes(uint8_t crc, const uint8_t * data, size_t len);

owb_ret_t owb_search_first(OneWireBus * bus, OneWireBus_SearchState * state, bool *found_device);

owb_ret_t owb_search_next(OneWireBus * bus, OneWireBus_SearchState * state, bool *found_device);

char * owb_string_from_rom_code(OneWireBus_ROMCode *rom_code, char * buffer, size_t len);

owb_ret_t owb_set_strong_pullup(OneWireBus * bus, bool enable);

In this article I will create and/or copy the missing functions. As I look through his implementation I also notice that we have some style differences that I will discuss. In general I will say that his implementation is very good and any place that I did something different was just a matter of programming taste.

I was origi