Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/workflows/android.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Android CI

on:
push:
branches: [ "main", "master" ]
pull_request:
branches: [ "main", "master" ]

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: set up JDK 17
uses: actions/setup-java@v4
with:
java-version: '17'
distribution: 'temurin'
cache: gradle

- name: Grant execute permission for gradlew
run: chmod +x gradlew

- name: Run Unit Tests
run: ./gradlew test

- name: Build with Gradle
run: ./gradlew assembleDebug

- name: Upload APK
uses: actions/upload-artifact@v4
with:
name: app-debug
path: app/build/outputs/apk/debug/app-debug.apk
45 changes: 45 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Android Release

on:
push:
tags:
- 'v*' # Triggers on tags starting with v (e.g., v1.0.0)

jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write

steps:
- uses: actions/checkout@v4

- name: set up JDK 17
uses: actions/setup-java@v4
with:
java-version: '17'
distribution: 'temurin'
cache: gradle

- name: Grant execute permission for gradlew
run: chmod +x gradlew

- name: Build Release APK
run: ./gradlew assembleRelease
env:
# These will be needed in build.gradle.kts to sign the APK
# If not provided, it will still build an unsigned APK
KEYSTORE_PASSWORD: ${{ secrets.KEYSTORE_PASSWORD }}
KEY_ALIAS: ${{ secrets.KEY_ALIAS }}
KEY_PASSWORD: ${{ secrets.KEY_PASSWORD }}

- name: Create GitHub Release
uses: softprops/action-gh-release@v2
with:
files: app/build/outputs/apk/release/app-release-unsigned.apk # Default if not signed
# If signed, the path might be app-release.apk
# We can use a wildcard to be safe
# files: app/build/outputs/apk/release/*.apk
generate_release_notes: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
130 changes: 130 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# Contributor Covenant Code of Conduct

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Contributing to abcomm

The following is a set of guidelines for contributing to **abcomm** and its package, which are hosted in the [abcomm](https://github.com/electux/abcomm) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

## Code of Conduct

**abcomm** project and everyone participating in it is governed by the [abcomm code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [abcomm](mailto:elektron.ronca@gmail.com).
19 changes: 19 additions & 0 deletions PRIVACY_POLICY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Privacy Policy for ABComm

**Effective Date: August 20, 2026**

This Privacy Policy describes how ABComm ("we", "us", or "our") handles information when you use our mobile application.

## 1. Information We Collect
ABComm is designed to be a tool for controlling hardware via Bluetooth Low Energy (BLE).
- **Bluetooth/Location Data**: To connect to BLE devices, Android requires Bluetooth and Location permissions. We use these only to scan for and connect to your relay devices.
- **Personal Data**: We do **NOT** collect, store, or share any personal information, account data, or usage statistics.

## 2. Third-Party Sharing
We do not share any data with third parties. All communication happens locally between your phone and the BLE hardware.

## 3. Data Retention
Since we do not collect any data, no data is retained on our servers.

## 4. Contact
If you have any questions, you can contact us via our GitHub repository: [https://github.com/electux/abcomm](https://github.com/electux/abcomm).
114 changes: 113 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,113 @@
# abcommander
# ABComm - Advanced Bluetooth Relay Control

<img align="right" src="https://raw.githubusercontent.com/electux/abcomm/main/docs/logo.svg" width="25%">

**ABComm** is a futuristic Android application designed for high-performance control of relay devices via Bluetooth Low Energy (BLE).

Developed with **[Kotlin](https://kotlinlang.org/)** and **Jetpack Compose**.

This application provides a "Cyberpunk" styled interface to manage up to 8 independent channels (relays) with real-time status monitoring and secure communication protocols.

[![Build Status](https://github.com/electux/abcomm/actions/workflows/android.yml/badge.svg)](https://github.com/electux/abcomm/actions)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![GitHub issues open](https://img.shields.io/github/issues/electux/abcomm.svg)](https://github.com/electux/abcomm/issues)
[![GitHub contributors](https://img.shields.io/github/contributors/electux/abcomm.svg)](https://github.com/electux/abcomm/graphs/contributors)

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**

- [🚀 Installation](#-installation)
- [Build from Source](#build-from-source)
- [Download APK](#download-apk)
- [📦 Dependencies](#-dependencies)
- [📁 Project Structure](#-project-structure)
- [✨ Features](#-features)
- [🛠 Usage](#-usage)
- [👥 Contributing](#-contributing)
- [📄 Copyright and licence](#-copyright-and-licence)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

### 🚀 Installation

Developed and tested on **Android 14 (API 34)** and newer.

##### Build from Source

You can build **ABComm** using Android Studio or Gradle.

```bash
# Clone the repository
git clone https://github.com/electux/abcomm.git
cd abcomm

# Build Debug APK
./gradlew assembleDebug
```

##### Download APK

Navigate to the **[Releases](https://github.com/electux/abcomm/releases/)** page to download the latest signed APK or App Bundle.

### 📦 Dependencies

**ABComm** requires the following permissions and hardware:

* **Bluetooth Low Energy (BLE)** capable device.
* **Android 7.0 (API 24)** or higher.
* Permissions: `BLUETOOTH_SCAN`, `BLUETOOTH_CONNECT`, `ACCESS_FINE_LOCATION`.

### 📁 Project Structure

**ABComm** follows the MVVM (Model-View-ViewModel) architecture.

Project structure

<details>
<summary><b>Click to expand app structure</b></summary>

```bash
app/
├── src/
│ ├── main/
│ │ ├── java/com/abcomm/
│ │ │ ├── MainActivity.kt # Main UI Entry Point
│ │ │ ├── MainViewModel.kt # UI State & Logic
│ │ │ └── BluetoothService.kt # BLE Communication Provider
│ │ └── res/
│ │ ├── drawable/ # Cyber-style Icons
│ │ └── values/ # Futuristic Color Palette
│ └── test/ # Unit Tests (MockK)
└── build.gradle.kts # Build Configuration
```
</details>

#### ✨ Features

* **Futuristic UI**: High-contrast "Cyberpunk" design with custom vector graphics.
* **8-Channel Control**: Independent toggle for each relay with individual status indicators.
* **Real-time Monitoring**: Instant feedback on connection status and relay states.
* **Secure BLE Link**: Efficient communication protocol using unique UUIDs.
* **Master Control**: Single-tap "All Channels ON" and "Force Shutdown" functions.
* **Unit Tested**: Robust logic verified with 100% core coverage.

### 🛠 Usage

1. **Enable Bluetooth**: Ensure Bluetooth is active on your smartphone.
2. **Scan for Device**: Launch ABComm and tap **CONNECT** to scan for available relay boards.
3. **Control**: Use the channel grid to toggle specific relays or use the Master Control for group actions.

### 👥 Contributing

[Contributing to abcomm](CONTRIBUTING.md)

### 📄 Copyright and licence

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Copyright (C) 2026 by [electux.github.io/abcomm](https://github.com/electux)

**ABComm** is open-source software licensed under the **MIT License**.

Feel free to fork, modify, and improve the project!
1 change: 1 addition & 0 deletions app/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/build
Loading
Loading