Usage - solum-signage-system/solum-signage-example GitHub Wiki

Usage

This section provides a guide on how to interact with and understand the core functionalities demonstrated in the SoluM Signage Feature Examples Android application. This app showcases direct device operations and SoluM's Device API usage.

1. Understanding the Application Structure

This example is a native Android application. Its core purpose is to demonstrate how to call SoluM's Device APIs and perform operations that typically require direct access to the Android system or specialized hardware.

  • Main Activity/Fragments: The application's UI and logic will be primarily within Android Activities or Fragments.
  • API Calls: Look for code snippets demonstrating calls to SoluM's Device API. These might involve:
    • Controlling display settings (brightness, orientation).
    • Managing device power (reboot, shutdown).
    • Accessing system information.

2. Exploring Device API Examples

Navigate through the application's user interface to find different features. Each button or section typically represents an example of a specific Device API call or operation.

a. Identifying API Usage

  • Source Code: The best way to understand the usage is to examine the Android Kotlin/Java source files (e.g., .kt or .java files) within Android Studio.
  • API Calls: Search for calls to SoluM-specific APIs or common Android system services that might be wrapped by SoluM's API.

b. Common API Operation Categories (Examples)

  • Display Control: Examples of changing screen brightness, setting display resolution, or adjusting orientation.
    • Look for: setBrightness(), setOrientation() or similar methods.
  • Power Management: Demonstrations of programmatically rebooting or shutting down the device.
    • Look for: rebootDevice(), shutdownDevice() or similar methods.
  • System Information Retrieval: Examples of getting device serial numbers, firmware versions, or network status.
    • Look for: getDeviceSerial(), getFirmwareVersion() or similar methods.

Next Step: See practical applications and specific code snippets in the Examples section.