Merge branch 'piggz-nav' into develop

Author: JF002

doc/NavigationService.md

@@ -0,0 +1,118 @@
+# Navigation Service
+## Introduction
+The navigation ble service provides 4 characteristics to allow the the watch to display navigation instructions from a companion application.  The intended purpose is when performing some outdoor activities, for example running or cycling.
+
+The 4 characteristics are:
+flag (string) - Upcoming icon name
+narrative (string) - Textual description of instruction
+manDist (string) - Manouvre Distance, the distance to the upcoming change
+progress (uint8) - Percent complete of total route, value 0-100
+
+## Service
+The service UUID is c7e60001-78fc-48fe-8e23-433b3a1942d0
+
+## Characteristics
+## Flags (UUID c7e60002-78fc-48fe-8e23-433b3a1942d0)
+All included icons are from pure-maps, which provides the actual routing from the client. The icon names ultimately come from the mapbox project "direction-icons", See https://github.com/rinigus/pure-maps/tree/master/qml/icons/navigation See the end of this document for the full lsit of supported icon names.
+
+## Narrative (UUID c7e60003-78fc-48fe-8e23-433b3a1942d0)
+This is a client supplied string describing the upcoming instruction such as "At the roundabout take the first exit".
+
+## Man Dist (UUID c7e60004-78fc-48fe-8e23-433b3a1942d0)
+This is a short string describing the distance to the upcoming instruction such as "50 m".
+
+## Progress (UUID c7e60001=5-78fc-48fe-8e23-433b3a1942d0)
+The percent complete in a uint8.  The watch displays this as an overall progress in a progress bar.
+
+## Full icon list
+* arrive
+* arrive-left
+* arrive-right
+* arrive-straight
+* close
+* continue
+* continue-left
+* continue-right
+* continue-slight-left
+* continue-slight-right
+* continue-straight
+* continue-uturn
+* depart
+* depart-left
+* depart-right
+* depart-straight
+* end-of-road-left
+* end-of-road-right
+* ferry
+* flag
+* fork
+* fork-left
+* fork-right
+* fork-slight-left
+* fork-slight-right
+* fork-straight
+* invalid
+* invalid-left
+* invalid-right
+* invalid-slight-left
+* invalid-slight-right
+* invalid-straight
+* invalid-uturn
+* merge-left
+* merge-right
+* merge-slight-left
+* merge-slight-right
+* merge-straight
+* new-name-left
+* new-name-right
+* new-name-sharp-left
+* new-name-sharp-right
+* new-name-slight-left
+* new-name-slight-right
+* new-name-straight
+* notification-left
+* notification-right
+* notification-sharp-left
+* notification-sharp-right
+* notification-slight-left
+* notification-slight-right
+* notification-straight
+* off-ramp-left
+* off-ramp-right
+* off-ramp-sharp-left
+* off-ramp-sharp-right
+* off-ramp-slight-left
+* off-ramp-slight-right
+* off-ramp-straight
+* on-ramp-left
+* on-ramp-right
+* on-ramp-sharp-left
+* on-ramp-sharp-right
+* on-ramp-slight-left
+* on-ramp-slight-right
+* on-ramp-straight
+* rotary
+* rotary-left
+* rotary-right
+* rotary-sharp-left
+* rotary-sharp-right
+* rotary-slight-left
+* rotary-slight-right
+* rotary-straight
+* roundabout
+* roundabout-left
+* roundabout-right
+* roundabout-sharp-left
+* roundabout-sharp-right
+* roundabout-slight-left
+* roundabout-slight-right
+* roundabout-straight
+* turn-left
+* turn-right
+* turn-sharp-left
+* turn-sharp-right
+* turn-slight-left
+* turn-slight-right
+* turn-stright
+* updown
+* uturn

src/CMakeLists.txt

@@ -322,6 +322,96 @@ list(APPEND IMAGE_FILES
 
         displayapp/icons/bluetooth/os_bt_connected.c
         displayapp/icons/bluetooth/os_bt_disconnected.c
+
+        displayapp/icons/navigation/arrive-left.c
+        displayapp/icons/navigation/arrive-right.c
+        displayapp/icons/navigation/arrive-straight.c
+        displayapp/icons/navigation/arrive.c
+        displayapp/icons/navigation/close.c
+        displayapp/icons/navigation/continue-left.c
+        displayapp/icons/navigation/continue-right.c
+        displayapp/icons/navigation/continue-slight-left.c
+        displayapp/icons/navigation/continue-slight-right.c
+        displayapp/icons/navigation/continue-straight.c
+        displayapp/icons/navigation/continue-uturn.c
+        displayapp/icons/navigation/continue.c
+        displayapp/icons/navigation/depart-left.c
+        displayapp/icons/navigation/depart-right.c
+        displayapp/icons/navigation/depart-straight.c
+        displayapp/icons/navigation/end-of-road-left.c
+        displayapp/icons/navigation/end-of-road-right.c
+        displayapp/icons/navigation/ferry.c
+        displayapp/icons/navigation/flag.c
+        displayapp/icons/navigation/fork-left.c
+        displayapp/icons/navigation/fork-right.c
+        displayapp/icons/navigation/fork-slight-left.c
+        displayapp/icons/navigation/fork-slight-right.c
+        displayapp/icons/navigation/fork-straight.c
+        displayapp/icons/navigation/invalid.c
+        displayapp/icons/navigation/invalid-left.c
+        displayapp/icons/navigation/invalid-right.c
+        displayapp/icons/navigation/invalid-slight-left.c
+        displayapp/icons/navigation/invalid-slight-right.c
+        displayapp/icons/navigation/invalid-straight.c
+        displayapp/icons/navigation/invalid-uturn.c
+        displayapp/icons/navigation/merge-left.c
+        displayapp/icons/navigation/merge-right.c
+        displayapp/icons/navigation/merge-slight-left.c
+        displayapp/icons/navigation/merge-slight-right.c
+        displayapp/icons/navigation/merge-straight.c
+        displayapp/icons/navigation/new-name-left.c
+        displayapp/icons/navigation/new-name-right.c
+        displayapp/icons/navigation/new-name-sharp-left.c
+        displayapp/icons/navigation/new-name-sharp-right.c
+        displayapp/icons/navigation/new-name-slight-left.c
+        displayapp/icons/navigation/new-name-slight-right.c
+        displayapp/icons/navigation/new-name-straight.c
+        displayapp/icons/navigation/notification-left.c
+        displayapp/icons/navigation/notification-right.c
+        displayapp/icons/navigation/notification-sharp-left.c
+        displayapp/icons/navigation/notification-sharp-right.c
+        displayapp/icons/navigation/notification-slight-left.c
+        displayapp/icons/navigation/notification-slight-right.c
+        displayapp/icons/navigation/notification-straight.c
+        displayapp/icons/navigation/off-ramp-left.c
+        displayapp/icons/navigation/off-ramp-right.c
+        displayapp/icons/navigation/off-ramp-sharp-left.c
+        displayapp/icons/navigation/off-ramp-sharp-right.c
+        displayapp/icons/navigation/off-ramp-slight-left.c
+        displayapp/icons/navigation/off-ramp-slight-right.c
+        displayapp/icons/navigation/off-ramp-straight.c
+        displayapp/icons/navigation/on-ramp-left.c
+        displayapp/icons/navigation/on-ramp-right.c
+        displayapp/icons/navigation/on-ramp-sharp-left.c
+        displayapp/icons/navigation/on-ramp-sharp-right.c
+        displayapp/icons/navigation/on-ramp-slight-left.c
+        displayapp/icons/navigation/on-ramp-slight-right.c
+        displayapp/icons/navigation/on-ramp-straight.c
+        displayapp/icons/navigation/rotary.c
+        displayapp/icons/navigation/rotary-left.c
+        displayapp/icons/navigation/rotary-right.c
+        displayapp/icons/navigation/rotary-sharp-left.c
+        displayapp/icons/navigation/rotary-sharp-right.c
+        displayapp/icons/navigation/rotary-slight-left.c
+        displayapp/icons/navigation/rotary-slight-right.c
+        displayapp/icons/navigation/rotary-straight.c
+        displayapp/icons/navigation/roundabout.c
+        displayapp/icons/navigation/roundabout-left.c
+        displayapp/icons/navigation/roundabout-right.c
+        displayapp/icons/navigation/roundabout-sharp-left.c
+        displayapp/icons/navigation/roundabout-sharp-right.c
+        displayapp/icons/navigation/roundabout-slight-left.c
+        displayapp/icons/navigation/roundabout-slight-right.c
+        displayapp/icons/navigation/roundabout-straight.c
+        displayapp/icons/navigation/turn-left.c
+        displayapp/icons/navigation/turn-right.c
+        displayapp/icons/navigation/turn-sharp-left.c
+        displayapp/icons/navigation/turn-sharp-right.c
+        displayapp/icons/navigation/turn-slight-left.c
+        displayapp/icons/navigation/turn-slight-right.c
+        displayapp/icons/navigation/turn-stright.c
+        displayapp/icons/navigation/updown.c
+        displayapp/icons/navigation/uturn.c
         )
 
 list(APPEND SOURCE_FILES
@@ -345,6 +435,7 @@ list(APPEND SOURCE_FILES
         displayapp/screens/Label.cpp
         displayapp/screens/FirmwareUpdate.cpp
         displayapp/screens/Music.cpp
+        displayapp/screens/Navigation.cpp
         displayapp/screens/FirmwareValidation.cpp
         displayapp/screens/ApplicationList.cpp
         displayapp/screens/Notifications.cpp
@@ -372,6 +463,7 @@ list(APPEND SOURCE_FILES
         components/ble/CurrentTimeService.cpp
         components/ble/AlertNotificationService.cpp
         components/ble/MusicService.cpp
+        components/ble/NavigationService.cpp
         components/ble/BatteryInformationService.cpp
         components/ble/ImmediateAlertService.cpp
         components/ble/ServiceDiscovery.cpp

src/components/ble/NavigationService.cpp

@@ -0,0 +1,137 @@
+/*  Copyright (C) 2021  Adam Pigg
+
+    This file is part of InfiniTime.
+
+    InfiniTime is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    InfiniTime is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
+#include "NavigationService.h"
+
+#include "systemtask/SystemTask.h"
+
+int NAVCallback(uint16_t conn_handle, uint16_t attr_handle, struct ble_gatt_access_ctxt *ctxt, void *arg) {
+  auto navService = static_cast<Pinetime::Controllers::NavigationService *>(arg);
+  return navService->OnCommand(conn_handle, attr_handle, ctxt);
+}
+
+Pinetime::Controllers::NavigationService::NavigationService(Pinetime::System::SystemTask &system) : m_system(system) {
+  navUuid.value[14] = navId[0];
+  navUuid.value[15] = navId[1];
+
+  navFlagCharUuid.value[12] = navFlagCharId[0];
+  navFlagCharUuid.value[13] = navFlagCharId[1];
+  navFlagCharUuid.value[14] = navId[0];
+  navFlagCharUuid.value[15] = navId[1];
+
+  navNarrativeCharUuid.value[12] = navNarrativeCharId[0];
+  navNarrativeCharUuid.value[13] = navNarrativeCharId[1];
+  navNarrativeCharUuid.value[14] = navId[0];
+  navNarrativeCharUuid.value[15] = navId[1];
+
+  navManDistCharUuid.value[12] = navManDistCharId[0];
+  navManDistCharUuid.value[13] = navManDistCharId[1];
+  navManDistCharUuid.value[14] = navId[0];
+  navManDistCharUuid.value[15] = navId[1];
+
+  navProgressCharUuid.value[12] = navProgressCharId[0];
+  navProgressCharUuid.value[13] = navProgressCharId[1];
+  navProgressCharUuid.value[14] = navId[0];
+  navProgressCharUuid.value[15] = navId[1];
+
+  characteristicDefinition[0] = {.uuid = (ble_uuid_t *) (&navFlagCharUuid),
+      .access_cb = NAVCallback,
+      .arg = this,
+      .flags =  BLE_GATT_CHR_F_WRITE | BLE_GATT_CHR_F_READ
+  };
+
+  characteristicDefinition[1] = {.uuid = (ble_uuid_t *) (&navNarrativeCharUuid),
+      .access_cb = NAVCallback,
+      .arg = this,
+      .flags = BLE_GATT_CHR_F_WRITE | BLE_GATT_CHR_F_READ
+  };
+  characteristicDefinition[2] = {.uuid = (ble_uuid_t *) (&navManDistCharUuid),
+      .access_cb = NAVCallback,
+      .arg = this,
+      .flags = BLE_GATT_CHR_F_WRITE | BLE_GATT_CHR_F_READ
+  };
+  characteristicDefinition[3] = {.uuid = (ble_uuid_t *) (&navProgressCharUuid),
+      .access_cb = NAVCallback,
+      .arg = this,
+      .flags = BLE_GATT_CHR_F_WRITE | BLE_GATT_CHR_F_READ
+  };
+
+  characteristicDefinition[4] = {0};
+
+  serviceDefinition[0] = {
+      .type = BLE_GATT_SVC_TYPE_PRIMARY,
+      .uuid = (ble_uuid_t *) &navUuid,
+      .characteristics = characteristicDefinition
+  };
+  serviceDefinition[1] = {0};
+
+  m_progress = 0;
+}
+
+void Pinetime::Controllers::NavigationService::Init() {
+  int res = 0;
+  res = ble_gatts_count_cfg(serviceDefinition);
+  ASSERT(res == 0);
+
+  res = ble_gatts_add_svcs(serviceDefinition);
+  ASSERT(res == 0);
+}
+
+int Pinetime::Controllers::NavigationService::OnCommand(uint16_t conn_handle, uint16_t attr_handle,
+                                                   struct ble_gatt_access_ctxt *ctxt) {
+
+  if (ctxt->op == BLE_GATT_ACCESS_OP_WRITE_CHR) {
+    size_t notifSize = OS_MBUF_PKTLEN(ctxt->om);
+    uint8_t data[notifSize + 1];
+    data[notifSize] = '\0';
+    os_mbuf_copydata(ctxt->om, 0, notifSize, data);
+    char *s = (char *) &data[0];
+    NRF_LOG_INFO("DATA : %s", s);
+    if (ble_uuid_cmp(ctxt->chr->uuid, (ble_uuid_t *) &navFlagCharUuid) == 0) {
+      m_flag = s;
+    } else if (ble_uuid_cmp(ctxt->chr->uuid, (ble_uuid_t *) &navNarrativeCharUuid) == 0) {
+      m_narrative = s;
+    } else if (ble_uuid_cmp(ctxt->chr->uuid, (ble_uuid_t *) &navManDistCharUuid) == 0) {
+      m_manDist = s;
+    } else if (ble_uuid_cmp(ctxt->chr->uuid, (ble_uuid_t *) &navProgressCharUuid) == 0) {
+      m_progress = data[0];
+    }
+  }
+  return 0;
+}
+
+std::string Pinetime::Controllers::NavigationService::getFlag()
+{
+    return m_flag;
+}
+
+std::string Pinetime::Controllers::NavigationService::getNarrative()
+{
+    return m_narrative;
+}
+
+std::string Pinetime::Controllers::NavigationService::getManDist()
+{
+    return m_manDist;
+}
+
+int Pinetime::Controllers::NavigationService::getProgress()
+{
+    return m_progress;
+}
+