Installation Guide - solum-signage-system/solum-signage-example GitHub Wiki

1. Prerequisites

Before you begin, you will need:

a. Android Studio

Requirement: The project needs to be built using Android Studio.
Download: You can download Android Studio from the official Android Developers website.

b. GitHub Account & Personal Access Token (PAT)

Requirement: To access the necessary packages for this project, you need a GitHub Personal Access Token.
Generate PAT: Please refer to the following document to create your token: https://catkin-gargoyle-8a3.notion.site/Devie-API-package-import-9ea28026f1c54b238f9781c088701384

2. Project Setup & Configuration

a. Open Project in Android Studio

Open the SoluM Signage Feature Examples project in Android Studio.

b. Modify `settings.gradle.kts`

You need to configure your GitHub credentials to fetch project dependencies.

Locate the settings.gradle.kts file at the root of the project.
Find the lines containing username = "USER" and password = "SECRET".
Replace USER with your GitHub account username.
Replace SECRET with your generated GitHub Personal Access Token.
```
username = "YOUR_GITHUB_USERNAME"
password = "YOUR_GITHUB_PERSONAL_ACCESS_TOKEN"
```
⚠️ Important Security Note: To prevent GitHub Push Protection errors and enhance security, it is strongly recommended to manage sensitive information like your username and Personal Access Token using Gradle Properties or Environment Variables instead of hardcoding them directly into settings.gradle.kts. This prevents accidental exposure of your credentials.

3. Build the Project

Once the settings.gradle.kts file is configured, you can build the project.

a. Sync Gradle

Android Studio should automatically prompt you to sync Gradle files after modifying settings.gradle.kts. If not, click the "Sync Project with Gradle Files" button in the toolbar.

b. Build APK

Build the project within Android Studio to generate the APK file.

Go to Build > Build Bundles(s) / APK(s) > Build APK(s).
Android Studio will compile the project and generate the .apk file, usually located in app/build/outputs/apk/debug or app/release.

4. Install on SoluM Signage Device

After generating the APK, you need to transfer and install it on your SoluM Signage Device.

a. Copy APK to USB Memory

Copy the generated APK file (e.g., app-debug.apk or app-release.apk) to a USB memory stick.

b. Connect USB Memory to Device

Connect the USB memory stick to your SoluM signage device.

c. Install via CMS PlayWizard

On your SoluM Signage device, locate and run the CMS PlayWizard application.
When Solum Signage example (or a similar name) appears on the screen, select it.
Follow the on-screen instructions within CMS PlayWizard to complete the installation of the example application.

5. Run the Application

Once the installation is complete:

a. Launch the App

Run the newly installed Solum Signage example application on your SoluM Signage device.

b. Explore Features

The application should now be running, showcasing various features and API usage examples of SoluM Signage.