Skip to content

Welcome to the OVES Software Architecture documentation.

This guide provides a thorough overview of the application, covering its APIs, endpoints, integrations, IoT embeddings, and microservices used throughout the system. The documentation is structured to help you understand the different components and how they work together to provide a seamless solution for IoT communication and device management.

Key Sections:

Introduction to the Architecture

A detailed overview of the OVES Software Architecture, explaining the core components and their interactions.

Includes guidance on API usage, microservices, and integration points to ensure smooth communication between the various layers.

Shadow API and Endpoints

  • Overview: A broad introduction to how the Shadow API functions, including API versioning, endpoint structure, and deployment processes.
  • Architecture: Details of the backend architecture, explaining how APIs and endpoints are organized within the system.
  • BLE Workflow: Covers the Bluetooth Low Energy (BLE) workflow, specifically how devices communicate, manage connections, and advertise services.
  • WebView Initialization: Describes the process of WebView integration, ensuring that the front-end interfaces properly with the backend API and IoT devices.

Purpose of the Documentation:

This documentation serves as a comprehensive guide to understanding the OVES Software Architecture. It will assist developers, system integrators, and operations teams in:

  • API integration: How to connect with and use the Shadow API and its endpoints.
  • End-to-end communication: Understanding the communication flow between the BLE devices, webview, and backend services.
  • Deployment: Guidance on deploying and versioning the APIs and services in the system.
  • IoT integrations: Understanding how IoT devices and services are embedded and integrated within the software architecture.

This rough overview introduces the key sections and purpose of the OVES Software Architecture documentation. It serves as an initial point to dive deeper into specific areas, whether you are configuring APIs, working on IoT integrations, or deploying services.