Kris-Dial

🧩 Built with Love and Madness Using:

🔗 Quick Links

• 📍 Overview
• 👾 Features
• 📁 Project Structure
  • 📂 Project Index
• 🚀 Getting Started
  • ☑️ Prerequisites
  • ⚙️ Installation
  • 🤖 Usage
  • 🧪 Testing
• 📌 Project Roadmap
• 🔰 Contributing
• 🎗 License
• 🙌 Acknowledgments

---

📍 Overview

This is a small project that will allow a user to flash an ESP32 dev-board with the included code, and controll a digital output pin as if it was a bass knob. This is in an extreme WIP stage and will slowly work more and more as it is worked on, see features for what is working.

---

👾 Features

ESP32 BLE Control for Knob

• Users can link devices and control a level-style knob to adjust gain or volume.

Bluetooth Low Energy (BLE)

• Users can link their ESP32 device with the app using BLE technology, allowing for seamless communication between the two.

Device Linking

• Users can easily link their devices by scanning for available devices and selecting the one they want to control.

Level-Style Knob Control

• Users can adjust the gain or volume of their device using a level-style knob, allowing for precise control over the audio output.

Customizable Settings

• Users can customize various settings such as the range of the knob, the minimum and maximum values, and the step size to suit their preferences.

Real-Time Updates

• The app will provide real-time updates on the current value of the knob, allowing users to see how it is affecting the audio output in real-time.

Compatible with Multiple Devices

• Users can control multiple devices simultaneously using the app, making it ideal for use cases such as controlling multiple speakers or amplifiers.

📁 Project Structure

└── krisDial/
    ├── ESP32
    │   ├── ESP32.ino
    │   └── ESP32Client.ino
    ├── config.xml
    ├── jsconfig.json
    ├── package-lock.json
    ├── package.json
    ├── typings
    │   └── cordova-typings.d.ts
    └── www
        ├── css
        ├── img
        ├── index.html
        └── js

📂 Project Index

KRISDIAL/

__root__

package-lock.json	NPM Generated file
jsconfig.json	Config file for Cordova
package.json	NPM Generated file

ESP32

ESP32Client.ino	Main ESP Code
ESP32.ino	Secondary ESP Code

www

index.html

Main Application GUI layout

css

index.cs	Static styles for the index
custom.css	Custom styles to be used across all built in Pages

js

index.js	Javascript driver file for the index
jquery-3.7.1.slim.min.js	Jquery for easy HTML Dom element access

typings

cordova-typings.d.ts

Cordova Type script Reference file

---

🚀 Getting Started

☑️ Prerequisites

Before getting started with krisDial, ensure your runtime environment meets the following requirements:

• Programming Language: HTML + Javascript
• Package Manager: Npm
• Required Software: Android Studio
• Android Version: Latest

⚙️ Installation

Install krisDial using one of the following methods:

Build from source:

1. Clone the krisDial repository:

❯ git clone https://github.com/retreat896/krisDial

2. Navigate to the project directory:

❯ cd krisDial

3. Install the project dependencies:

Using npm  

❯ npm install

🤖 Usage

Find your virtual Android Device using the following command: Using npm  

❯ emulator -list-avds

Run krisDial using the following command: Using npm  

❯ emulator -avd YOUR_AVD_NAME

---

📌 Project Roadmap

• The Begining: Implement a basic BLE android app using Cordova
• ESP I/O: Implement the client and server for the BLE on the ESP
• Application I/O: Implement the client and server for the application side
• UI Overhaul: Implement a flat modern style GUI for the application

---

🔰 Contributing

• 🐛 Report Issues: Submit bugs found or log feature requests for the krisDial project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/retreat896/krisDial

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

🛠️ Contributors

---