Skip to content
Badge Magic with LEDs - iOS App
Branch: master
Clone or download
Latest commit a640059 Sep 3, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs repo init Sep 3, 2019
CONTRIBUTING.md repo init Sep 3, 2019
LICENSE repo init Sep 3, 2019
README.md repo init Sep 3, 2019

README.md

Badge Magic

Build Status Join the chat at https://gitter.im/fossasia/badge-magic

Magically Create Text and Draw Cliparts on LED Name Badges using Bluetooth

The goal of the Badge Magic ios app is to let you create moving text and draw cliparts for to LED name badges. With the app we want to provide options to portray names, cliparts and simple animations on the badges. For the data transfer from the smartphone to the LED badge we use Bluetooth.

Permissions

  • Bluetooth: For sending data to the badge.
  • GPS Location: This has been the standard set by ios for use with Bluetooth Low Energy (BLE) devices. For more information, please read the notes on ios website.
  • Storage: For storing and saving badges.

Communication

Please talk to us on the badge-magic Gitter channel here.

Available Devices

There are a number of devices with Bluetooth on the market. As far as we can tell they are mostly from the same manufacturer. When you get a device ensure it comes with Bluetooth. There are devices that don't support Bluetooth. These are not supported in the app currently.

Reverse-Engineering Bluetooth LE Devices

Security in Bluetooth LE devices is optional, and many cheap products you can find on the market are not secured at all. This applies to our Bluetooth LED Badge. While this could lead to some privacy issues, this can also be a source of fun, especially when you want to use an LED Badge in a different way. It also makes it easy for us to get started with the development of a Free and Open Source ios app.

As we understand how the Bluetooth LED badge works, converting a text to multiple byte arrays, we can send using the Bluetooth LE APIs. An indepth blog post about reverse-engineering the Bluetooth community is here.

The implementation in the ios app consists of manipulating bits. That may be tricky. A single bit error and nothing will work, plus it will be hard to debug. For those reasons, and since the specs are perfectly clear the reverse engineer Gautier Mechling strongly recommends to start writing unit tests before the code implementation.

Branch Policy

We have the following branches

  • development All development goes on in this branch. If you're making a contribution, you are supposed to make a pull request to development. PRs to development branch must pass a build check on Travis CI.
  • master This contains shipped code. After significant features/bugfixes are accumulated on development, we make a version update and make a release.

Contributions Best Practices

Please read FOSSASIA's Best Practices before contributing. Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics. Here are some basics:

  • Single commit per pull request
  • For writing commit messages please read the CommitStyle.md.
  • Follow uniform design practices. The design language must be consistent throughout the app.
  • The pull request will not get merged until and unless the commits are squashed. In case there are multiple commits on the PR, the commit author needs to squash them and not the maintainers cherrypicking and merging squashes.
  • If the PR is related to any front end change, please attach relevant screenshots in the pull request description.
  • Before you join development, please set up the project on your local machine, run it and go through the application completely. Press on any button you can find and see where it leads to. Explore.
  • If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please free to drop in a comment and start working on it.

LICENSE

The application is licensed under the Apache License 2.0. Copyright is owned by FOSSASIA and its contributors.

You can’t perform that action at this time.