From 0c04e20ac3d3960243e0227fe27a3df003f55b79 Mon Sep 17 00:00:00 2001 From: James Rich <2199651+jamesarich@users.noreply.github.com> Date: Wed, 2 Jul 2025 12:00:28 -0500 Subject: [PATCH 1/2] Add README.md for mesh_service_example Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com> --- mesh_service_example/README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 mesh_service_example/README.md diff --git a/mesh_service_example/README.md b/mesh_service_example/README.md new file mode 100644 index 0000000000..d25c1fe3a3 --- /dev/null +++ b/mesh_service_example/README.md @@ -0,0 +1,32 @@ +# mesh_service_example + +This module provides an example implementation of a mesh service for the Meshtastic-Android project. + +## Overview + +`mesh_service_example` demonstrates how to build and integrate a custom mesh service within the Meshtastic ecosystem. It is intended as a reference for developers who want to extend or customize mesh-related functionality. + +## Features +- Example service structure for mesh integration +- Sample code for service registration and communication +- Reference for best practices in module development + +## Usage +1. Clone the Meshtastic-Android repository. +2. Open the project in Android Studio. +3. Explore the `mesh_service_example` module source code under `mesh_service_example/src/`. +4. Use this module as a template for your own mesh service implementations. + +## Development +- To build the module, use the standard Gradle build commands: + ```sh + ./gradlew :mesh_service_example:build + ``` +- To run tests for this module: + ```sh + ./gradlew :mesh_service_example:test + ``` + +## License +This example module is provided under the same license as the main Meshtastic-Android project. See the root `LICENSE` file for details. + From f4445994cd8d2a6f4818d4024eee3af7948e4829 Mon Sep 17 00:00:00 2001 From: James Rich <2199651+jamesarich@users.noreply.github.com> Date: Wed, 2 Jul 2025 12:37:01 -0500 Subject: [PATCH 2/2] docs: update mesh_service_example README The README for `mesh_service_example` has been updated to clarify that it's an example of an app using the AIDL Mesh Service provided by Meshtastic-Android, rather than an implementation of the service itself. It now also links to the AIDL definition in the main app module and removes a reference to best practices in module development, which is less relevant to an example consumer app. Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com> --- mesh_service_example/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/mesh_service_example/README.md b/mesh_service_example/README.md index d25c1fe3a3..58da409849 100644 --- a/mesh_service_example/README.md +++ b/mesh_service_example/README.md @@ -1,15 +1,16 @@ # mesh_service_example -This module provides an example implementation of a mesh service for the Meshtastic-Android project. +This module provides an example implementation of an app that uses the [AIDL](https://developer.android.com/develop/background-work/services/aidl) Mesh Service provided by Meshtastic-Android project. ## Overview +The [AIDL](../app/src/main/aidl/com/geeksville/mesh/IMeshService.aidl) is defined in the main app module and is used to interact with the mesh network. + `mesh_service_example` demonstrates how to build and integrate a custom mesh service within the Meshtastic ecosystem. It is intended as a reference for developers who want to extend or customize mesh-related functionality. ## Features - Example service structure for mesh integration - Sample code for service registration and communication -- Reference for best practices in module development ## Usage 1. Clone the Meshtastic-Android repository.