├── CNAME
├── shop
└── README.md
├── img
├── app_icon.png
├── screen-1.jpg
├── screen-2.jpg
├── screen-3.jpg
├── screen-4.jpg
├── screen-5.jpg
├── screen-6.jpg
├── badgemagic.jpg
├── fdroid_badge.png
├── screen-1-hard.png
├── screen-2-hard.png
├── screen-3-hard.png
├── screen-4-hard.png
├── screen-5-hard.png
├── screen-6-hard.png
├── google_play_badge.png
├── badgemagic-screen-1.jpg
└── app_icon.svg
├── .github
└── workflows
│ └── jekyll-gh-pages.yml
├── privacy
└── README.md
└── README.md
/CNAME:
--------------------------------------------------------------------------------
1 | badgemagic.fossasia.org
--------------------------------------------------------------------------------
/shop/README.md:
--------------------------------------------------------------------------------
1 | [Visit the PSLab shop](https://eu.pslab.io)
2 |
--------------------------------------------------------------------------------
/img/app_icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/app_icon.png
--------------------------------------------------------------------------------
/img/screen-1.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/screen-1.jpg
--------------------------------------------------------------------------------
/img/screen-2.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/screen-2.jpg
--------------------------------------------------------------------------------
/img/screen-3.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/screen-3.jpg
--------------------------------------------------------------------------------
/img/screen-4.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/screen-4.jpg
--------------------------------------------------------------------------------
/img/screen-5.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/screen-5.jpg
--------------------------------------------------------------------------------
/img/screen-6.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/screen-6.jpg
--------------------------------------------------------------------------------
/img/badgemagic.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/badgemagic.jpg
--------------------------------------------------------------------------------
/img/fdroid_badge.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/fdroid_badge.png
--------------------------------------------------------------------------------
/img/screen-1-hard.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/screen-1-hard.png
--------------------------------------------------------------------------------
/img/screen-2-hard.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/screen-2-hard.png
--------------------------------------------------------------------------------
/img/screen-3-hard.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/screen-3-hard.png
--------------------------------------------------------------------------------
/img/screen-4-hard.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/screen-4-hard.png
--------------------------------------------------------------------------------
/img/screen-5-hard.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/screen-5-hard.png
--------------------------------------------------------------------------------
/img/screen-6-hard.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/screen-6-hard.png
--------------------------------------------------------------------------------
/img/google_play_badge.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/google_play_badge.png
--------------------------------------------------------------------------------
/img/badgemagic-screen-1.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fossasia/badgemagic.fossasia.org/master/img/badgemagic-screen-1.jpg
--------------------------------------------------------------------------------
/.github/workflows/jekyll-gh-pages.yml:
--------------------------------------------------------------------------------
1 | # Sample workflow for building and deploying a Jekyll site to GitHub Pages
2 | name: Deploy Jekyll with GitHub Pages dependencies preinstalled
3 |
4 | on:
5 | # Runs on pushes targeting the default branch
6 | push:
7 | branches: ["master"]
8 |
9 | # Allows you to run this workflow manually from the Actions tab
10 | workflow_dispatch:
11 |
12 | # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13 | permissions:
14 | contents: read
15 | pages: write
16 | id-token: write
17 |
18 | # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
19 | # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
20 | concurrency:
21 | group: "pages"
22 | cancel-in-progress: false
23 |
24 | jobs:
25 | # Build job
26 | build:
27 | runs-on: ubuntu-latest
28 | steps:
29 | - name: Checkout
30 | uses: actions/checkout@v4
31 | - name: Setup Pages
32 | uses: actions/configure-pages@v5
33 | - name: Build with Jekyll
34 | uses: actions/jekyll-build-pages@v1
35 | with:
36 | source: ./
37 | destination: ./_site
38 | - name: Upload artifact
39 | uses: actions/upload-pages-artifact@v3
40 |
41 | # Deployment job
42 | deploy:
43 | environment:
44 | name: github-pages
45 | url: ${{ steps.deployment.outputs.page_url }}
46 | runs-on: ubuntu-latest
47 | needs: build
48 | steps:
49 | - name: Deploy to GitHub Pages
50 | id: deployment
51 | uses: actions/deploy-pages@v4
52 |
--------------------------------------------------------------------------------
/privacy/README.md:
--------------------------------------------------------------------------------
1 | ### Privacy Policy for LED Badge Magic Android App
2 |
3 | **Last updated: 11 May 2024**
4 |
5 | This privacy policy governs your use of the software application LED Badge Magic (“Application”) for mobile devices that was created by FOSSASIA. The Application is designed to allow users to create and transfer display messages to LED badges via Bluetooth Low Energy (BLE).
6 |
7 | **1. User Provided Information**
8 |
9 | The Application does not require users to provide any personal information. Users can download and use the Application without providing information such as name, email address, or other details.
10 |
11 | **2. Automatically Collected Information**
12 |
13 | The Application does not collect any information automatically from your device.
14 |
15 | **3. Location Permissions for Bluetooth Low Energy (BLE)**
16 |
17 | The Application requires location permissions to operate Bluetooth Low Energy (BLE) functionalities effectively:
18 |
19 | - **Foreground Location Permission**: The Application needs access to your device's precise location while it is in use (foreground) to identify and connect to nearby devices. This permission is necessary to transfer badge data to the identified devices via BLE.
20 |
21 | - **Background Location Permission**: The Application requires access to your device's location in the background to continuously scan and identify nearby objects that can receive badge data. This ensures that the application can maintain connections and transfer data to devices even when the app is not actively in use.
22 |
23 | Location data accessed for BLE functionalities is not stored on the device, transferred to our servers, or shared with third parties. These permissions are solely used to facilitate the connection and data transfer between your device and nearby BLE devices.
24 |
25 | **4. Bluetooth Access**
26 |
27 | The Application requires access to your device’s Bluetooth functionality to communicate with LED badges. This access is used exclusively for detecting and connecting to LED badges within the proximity of your device to facilitate the transfer of display messages. The Application does not use Bluetooth access for any other purposes nor does it track your location.
28 |
29 | **5. Do third parties see and/or have access to information obtained by the Application?**
30 |
31 | No. We do not share any information with third parties since the Application does not collect, store, or process any personal data.
32 |
33 | **6. Data Retention Policy, Managing Your Information**
34 |
35 | Since the Application does not collect, store, or process any personal data, there is no data retention policy applicable to this Application.
36 |
37 | **7. Children**
38 |
39 | We do not use the Application to knowingly solicit data from or market to children under the age of 13. If a parent or guardian becomes aware that his or her child has provided us with information without their consent, he or she should contact us.
40 |
41 | **8. Security**
42 |
43 | We are concerned about safeguarding the confidentiality of your information. However, please be aware that no security system can prevent all potential security breaches.
44 |
45 | **9. Changes**
46 |
47 | This Privacy Policy may be updated from time to time for any reason. We will notify you of any changes to our Privacy Policy by posting the new Privacy Policy here and informing you via app update notes. You are advised to consult this Privacy Policy regularly for any changes, as continued use is deemed approval of all changes.
48 |
49 | **10. Your Consent**
50 |
51 | By using the Application, you are consenting to our processing of your information as set forth in this Privacy Policy now and as amended by us. “Processing” means using Bluetooth on your device in the manner necessary to operate the Application as described above.
52 |
53 | **11. Contact Us**
54 |
55 | If you have any questions regarding privacy while using the Application, or have questions about our practices, please contact us via email at dev@fossasia.org.
56 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Badge Magic LED Badge
2 |
3 | **Magically Create Text and Draw Cliparts on LED Name Badges using Bluetooth**
4 |
5 | The Badge Magic Android app lets you create moving text and draw clipart for LED name badges. The app provides options to portray names, cliparts, and simple animations on the badges. For the data transfer from the smartphone to the LED badge it uses Bluetooth.
6 |
7 | | | | |
8 | |-------------|-------------|-------------|
9 | | | | |
10 |
11 |
12 | ## Android
13 |
14 | * [Google Playstore](https://play.google.com/store/apps/details?id=org.fossasia.badgemagic)
15 | * [Fdroid](https://f-droid.org/en/packages/org.fossasia.badgemagic/)
16 |
17 | ## iOS
18 |
19 | * [Badge Magic App on Apple store](https://apps.apple.com/us/app/badge-magic/id6740176888)
20 |
21 | ## **How to Switch the LED Badge On & Off**
22 |
23 | ### **Turning the LED Badge On**
24 | - Press the **top button** on the side of the LED badge once to turn it on.
25 |
26 | ### **Turning the LED Badge Off**
27 | - Press the **same button three times** in quick succession to power off the device.
28 |
29 | ### **Button Press Functions Overview:**
30 | 1. **First Press** → Turns the LED badge on.
31 | 2. **Second Press** → Activates **Bluetooth mode**, allowing message transfers.
32 | 3. **Third Press** → Turns the LED badge off.
33 |
34 | ---
35 |
36 | ## **How to Transfer Messages to the LED Badge**
37 |
38 | 1. **Scan the QR Code**
39 | - Locate the **QR code on the back** of the LED badge and scan it using your mobile device.
40 | - This will redirect you to the official website to download the app.
41 |
42 | 2. **Install the Right App**
43 | - Choose the compatible app for your device: **Android, iOS, or Python**.
44 |
45 | 3. **Enable Bluetooth on Your Mobile Device**
46 | - There is **no need to manually pair** your phone with the LED badge, as it uses **Bluetooth Low Energy (BLE)** for automatic connection.
47 |
48 | 4. **Enter Your Desired Message in the App**
49 | - Open the app and type in the text you want to display on the LED badge.
50 |
51 | 5. **Prepare the LED Badge for Transfer**
52 | - **Turn on the LED badge** by pressing the top button once.
53 | - **Press the button again** to activate **Bluetooth transfer mode**—a Bluetooth icon will appear on the display.
54 |
55 | 6. **Transfer the Message**
56 | - In the app, tap **"Transfer" or "Send"** to transmit your message to the LED badge.
57 | - The badge will update and display your new message in real time.
58 |
59 | 
60 |
61 | ## What is the other button for?
62 |
63 | The **second button** on the LED Badge serves multiple functions:
64 |
65 | - **Message Slot Switching:** This button allows users to **cycle through different pre-stored messages** on the badge. The **app is currently being updated** to fully support this feature, and it will be available in an upcoming release. This will enable users to seamlessly switch between multiple custom messages without needing to reconnect to the app.
66 |
67 | - **Brightness Control:** Holding down the **second button for a longer duration** will allow users to **increase or decrease the brightness of the LEDs**.
68 |
69 | ## Workshop
70 |
71 | * [Python Workshop (Google Doc)](https://docs.google.com/document/d/1Ax9lLDBA7hwRKgq2kBHhTh892YbRXS-ZGYeldZXPOwY/edit?tab=t.0)
72 |
73 | ## Development
74 |
75 | * [Badge Magic App Code](https://github.com/fossasia/badgemagic-app): Flutter app for Android, iOS, Linux, macOS, and Windows
76 | * [Python App Code](https://github.com/fossasia/led-name-badge-ls32)
77 | * [Rust App Code](https://github.com/fossasia/badgemagic-rs)
78 | * [Go App Code](https://github.com/fossasia/badgemagic-go)
79 | * [Badge Magic Firmware](https://github.com/fossasia/badgemagic-firmware)
80 |
81 | ## Hardware
82 |
83 | * [Badge Magic Hardware](https://github.com/fossasia/badgemagic-hardware)
84 | * [Badge Magic Case](https://github.com/fossasia/badgemagic-case)
85 |
86 | ## Web
87 |
88 | * [Visit the website here](https://badgemagic.fossasia.org)
89 |
--------------------------------------------------------------------------------
/img/app_icon.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
138 |
--------------------------------------------------------------------------------