mirror of https://github.com/meshtastic/Meshtastic-Android.git synced 2026-03-27 10:11:48 -04:00

Files

James Rich 986c60ce88 docs: Update READMEs and library versions

This commit updates the README files for the `core:api`, `core:model`, and `core:proto` modules to improve documentation and reflect current usage.

Key changes include:
- Bumping the library version to `v2.7.13` in usage examples.
- Adding a detailed README for the `core:proto` module.
- Updating the `core:api` README to use `MeshtasticIntent` constants instead of hardcoded strings.

Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>

2026-02-07 15:54:51 -06:00

1.5 KiB

Raw Blame History

`:core:proto`

Module dependency graph

graph TB
  :core:proto[proto]:::null

classDef android-application fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000;
classDef android-application-compose fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000;
classDef android-feature fill:#FFD6A5,stroke:#000,stroke-width:2px,color:#000;
classDef android-library fill:#9BF6FF,stroke:#000,stroke-width:2px,color:#000;
classDef android-library-compose fill:#9BF6FF,stroke:#000,stroke-width:2px,color:#000;
classDef android-test fill:#A0C4FF,stroke:#000,stroke-width:2px,color:#000;
classDef jvm-library fill:#BDB2FF,stroke:#000,stroke-width:2px,color:#000;
classDef kmp-library fill:#FFC1CC,stroke:#000,stroke-width:2px,color:#000;
classDef unknown fill:#FFADAD,stroke:#000,stroke-width:2px,color:#000;

Meshtastic Protobuf Definitions

This module contains the generated Kotlin and Java code from the Meshtastic Protobuf definitions. It uses the Wire library for efficient and clean model generation.

Key Components

Port Numbers: Defines the PortNum enum for identifying different types of data payloads.
Mesh Protocol: Contains the core MeshPacket and protocol message definitions.
Modules: Includes definitions for telemetry, position, administration, and more.

Usage

This module is typically used as a dependency of core:api and core:model.

implementation("com.github.meshtastic.Meshtastic-Android:meshtastic-android-proto:v2.7.13")

1.5 KiB Raw Blame History

:core:proto