libostentus: update to use as a Zephyr module

* Bump to libostentus v1.0.0
* Include using CONFIG_LIB_OSTENTUS
* Guard all calls to this library using the above symbol

Signed-off-by: Mike Szczys <[email protected]>

Author: szczys

.clang-format

@@ -87,3 +87,4 @@ UseTab: Always
 WhitespaceSensitiveMacros:
   - STRINGIFY
   - Z_STRINGIFY
+  - IF_ENABLED

.gitignore

@@ -6,4 +6,3 @@ build*/
 .cache
 credentials.conf
 __pycache__/
-libostentus

CMakeLists.txt

@@ -13,7 +13,6 @@ target_sources(app PRIVATE src/app_settings.c)
 target_sources(app PRIVATE src/app_state.c)
 target_sources(app PRIVATE src/app_work.c)
 target_sources(app PRIVATE src/dfu/app_dfu.c)
-target_sources(app PRIVATE src/libostentus/libostentus.c)
 target_sources_ifdef(CONFIG_BOOTLOADER_MCUBOOT app PRIVATE src/dfu/flash.c)
 
 add_subdirectory_ifdef(CONFIG_ALUDEL_BATTERY_MONITOR src/battery_monitor)

boards/aludel_mini_v1_sparkfun9160_ns.conf

@@ -40,3 +40,6 @@ CONFIG_GOLIOTH_RPC_MAX_RESPONSE_LEN=512
 
 # Generate MCUboot compatible images
 CONFIG_BOOTLOADER_MCUBOOT=y
+
+# Use Golioth Ostentus Faceplate
+CONFIG_LIB_OSTENTUS=y

src/app_work.c

@@ -11,8 +11,10 @@ LOG_MODULE_REGISTER(app_work, LOG_LEVEL_DBG);
 #include <zephyr/drivers/gpio.h>
 
 #include "app_work.h"
-#include "libostentus/libostentus.h"
 
+#ifdef CONFIG_LIB_OSTENTUS
+#include <libostentus.h>
+#endif
 #ifdef CONFIG_ALUDEL_BATTERY_MONITOR
 #include "battery_monitor/battery.h"
 #endif
@@ -40,10 +42,11 @@ void app_work_sensor_read(void)
 	int err;
 	char json_buf[256];
 
-	IF_ENABLED(CONFIG_ALUDEL_BATTERY_MONITOR,
-		   (read_and_report_battery();
-		    slide_set(BATTERY_V, get_batt_v_str(), strlen(get_batt_v_str()));
-		    slide_set(BATTERY_LVL, get_batt_lvl_str(), strlen(get_batt_lvl_str()));));
+	IF_ENABLED(CONFIG_ALUDEL_BATTERY_MONITOR, (
+		read_and_report_battery();
+		slide_set(BATTERY_V, get_batt_v_str(), strlen(get_batt_v_str()));
+		slide_set(BATTERY_LVL, get_batt_lvl_str(), strlen(get_batt_lvl_str()));
+	));
 
 	/* For this demo, we just send Hello to Golioth */
 	static uint8_t counter;
@@ -66,15 +69,16 @@ void app_work_sensor_read(void)
 		LOG_ERR("Failed to send sensor data to Golioth: %d", err);
 	}
 
-	/* Update slide values on Ostentus
-	 *  -values should be sent as strings
-	 *  -use the enum from app_work.h for slide key values
-	 */
-	snprintk(json_buf, sizeof(json_buf), "%d", counter);
-	slide_set(UP_COUNTER, json_buf, strlen(json_buf));
-	snprintk(json_buf, sizeof(json_buf), "%d", 255 - counter);
-	slide_set(DN_COUNTER, json_buf, strlen(json_buf));
-
+	IF_ENABLED(CONFIG_LIB_OSTENTUS, (
+		/* Update slide values on Ostentus
+		 *  -values should be sent as strings
+		 *  -use the enum from app_work.h for slide key values
+		 */
+		snprintk(json_buf, sizeof(json_buf), "%d", counter);
+		slide_set(UP_COUNTER, json_buf, strlen(json_buf));
+		snprintk(json_buf, sizeof(json_buf), "%d", 255 - counter);
+		slide_set(DN_COUNTER, json_buf, strlen(json_buf));
+	));
 	++counter;
 }
 

src/main.c

@@ -16,7 +16,10 @@ LOG_MODULE_REGISTER(golioth_rd_template, LOG_LEVEL_DBG);
 #include "app_state.h"
 #include "app_work.h"
 #include "dfu/app_dfu.h"
-#include "libostentus/libostentus.h"
+
+#ifdef CONFIG_LIB_OSTENTUS
+#include <libostentus.h>
+#endif
 #ifdef CONFIG_ALUDEL_BATTERY_MONITOR
 #include "battery_monitor/battery.h"
 #endif
@@ -40,7 +43,6 @@ static struct gpio_callback button_cb_data;
 
 /* forward declarations */
 void golioth_connection_led_set(uint8_t state);
-void network_led_set(uint8_t state);
 
 void wake_system_thread(void)
 {
@@ -67,7 +69,9 @@ static void golioth_on_connect(struct golioth_client *client)
 #ifdef CONFIG_SOC_NRF9160
 static void process_lte_connected(void)
 {
-	network_led_set(1);
+	/* Change the state of the Internet LED on Ostentus */
+	IF_ENABLED(CONFIG_LIB_OSTENTUS, (led_internet_set(1);));
+
 	golioth_system_client_start();
 }
 
@@ -164,15 +168,7 @@ void golioth_connection_led_set(uint8_t state)
 	/* Turn on Golioth logo LED once connected */
 	gpio_pin_set_dt(&golioth_led, pin_state);
 	/* Change the state of the Golioth LED on Ostentus */
-	led_golioth_set(pin_state);
-}
-
-/* Set (unset) LED indicators for active internet connection */
-void network_led_set(uint8_t state)
-{
-	uint8_t pin_state = state ? 1 : 0;
-	/* Change the state of the Internet LED on Ostentus */
-	led_internet_set(pin_state);
+	IF_ENABLED(CONFIG_LIB_OSTENTUS, (led_golioth_set(pin_state);));
 }
 
 int main(void)
@@ -184,11 +180,12 @@ int main(void)
 	LOG_INF("Firmware version: %s", CONFIG_MCUBOOT_IMAGE_VERSION);
 	IF_ENABLED(CONFIG_MODEM_INFO, (log_modem_firmware_version();));
 
-	/* Update Ostentus LEDS using bitmask (Power On and Battery)*/
-	led_bitmask(LED_POW | LED_BAT);
-
-	/* Show Golioth Logo on Ostentus ePaper screen */
-	show_splash();
+	IF_ENABLED(CONFIG_LIB_OSTENTUS, (
+		/* Update Ostentus LEDS using bitmask (Power On and Battery) */
+		led_bitmask(LED_POW | LED_BAT);
+		/* Show Golioth Logo on Ostentus ePaper screen */
+		show_splash();
+	));
 
 	/* Get system thread id so loop delay change event can wake main */
 	_system_thread = k_current_get();
@@ -258,26 +255,29 @@ int main(void)
 	gpio_init_callback(&button_cb_data, button_pressed, BIT(user_btn.pin));
 	gpio_add_callback(user_btn.port, &button_cb_data);
 
-	/* Set up a slideshow on Ostentus
-	 *  - add up to 256 slides
-	 *  - use the enum in app_work.h to add new keys
-	 *  - values are updated using these keys (see app_work.c)
-	 */
-	slide_add(UP_COUNTER, LABEL_UP_COUNTER, strlen(LABEL_UP_COUNTER));
-	slide_add(DN_COUNTER, LABEL_DN_COUNTER, strlen(LABEL_DN_COUNTER));
-	IF_ENABLED(CONFIG_ALUDEL_BATTERY_MONITOR,
-		   (slide_add(BATTERY_V, LABEL_BATTERY, strlen(LABEL_BATTERY));
-		    slide_add(BATTERY_LVL, LABEL_BATTERY, strlen(LABEL_BATTERY));));
-	slide_add(FIRMWARE, LABEL_FIRMWARE, strlen(LABEL_FIRMWARE));
-
-	/* Set the title ofthe Ostentus summary slide (optional) */
-	summary_title(SUMMARY_TITLE, strlen(SUMMARY_TITLE));
-
-	/* Update the Firmware slide with the firmware version */
-	slide_set(FIRMWARE, CONFIG_MCUBOOT_IMAGE_VERSION, strlen(CONFIG_MCUBOOT_IMAGE_VERSION));
-
-	/* Start Ostentus slideshow with 30 second delay between slides */
-	slideshow(30000);
+	IF_ENABLED(CONFIG_LIB_OSTENTUS,(
+		/* Set up a slideshow on Ostentus
+		 *  - add up to 256 slides
+		 *  - use the enum in app_work.h to add new keys
+		 *  - values are updated using these keys (see app_work.c)
+		 */
+		slide_add(UP_COUNTER, LABEL_UP_COUNTER, strlen(LABEL_UP_COUNTER));
+		slide_add(DN_COUNTER, LABEL_DN_COUNTER, strlen(LABEL_DN_COUNTER));
+		IF_ENABLED(CONFIG_ALUDEL_BATTERY_MONITOR, (
+			slide_add(BATTERY_V, LABEL_BATTERY, strlen(LABEL_BATTERY));
+			slide_add(BATTERY_LVL, LABEL_BATTERY, strlen(LABEL_BATTERY));
+		));
+		slide_add(FIRMWARE, LABEL_FIRMWARE, strlen(LABEL_FIRMWARE));
+
+		/* Set the title ofthe Ostentus summary slide (optional) */
+		summary_title(SUMMARY_TITLE, strlen(SUMMARY_TITLE));
+
+		/* Update the Firmware slide with the firmware version */
+		slide_set(FIRMWARE, CONFIG_MCUBOOT_IMAGE_VERSION, strlen(CONFIG_MCUBOOT_IMAGE_VERSION));
+
+		/* Start Ostentus slideshow with 30 second delay between slides */
+		slideshow(30000);
+	));
 
 	while (true) {
 		app_work_sensor_read();

west.yml

@@ -36,8 +36,8 @@ manifest:
       url: [email protected]:golioth/golioth-zephyr-boards.git
 
     - name: libostentus
-      path: app/src/libostentus
-      revision: 5d37e4160959881932d1dd869e1d238096878cf2
+      path: deps/modules/lib/libostentus
+      revision: v1.0.0
       url: [email protected]:golioth/libostentus.git
 
     - name: zephyr-network-info