Skip to content
/ KegCop Public

🍻 An iOS app monitoring kegerators using BLE (Bluetooth 4.0) communicating to a microcontroller.

License

Notifications You must be signed in to change notification settings

ipatch/KegCop

Repository files navigation

KegCop Build Status

Wilson demos KegCop

Objective

The purpose of this software is to create user accounts for a kegerator, and have a root account which receives donations from the users for the beer they drink. To find out more information about the project check out the wiki

How does it work

An iOS device, i.e. iPhone / iPod Touch will connect to a Bluno via Bluetooth 4.0 Low Energy sending serial information to the microcontroller which will communicate with flow sensor(s) and a solenoid cut off valve. The iOS device will be the user interface for the entire operation, storing account information along with how many credits a particular user will have.

Build

As of August 29, 2019, I'm building KegCop.app using Xcode Version 10.1 (10B61) for iOS 9.3.x deployed to a iPod Touch 5th generation model.

The iPod Touch 5th Gen has the same screen size and specs as iPhone 5 and 5s, which is useful to know when building using Simulator.app.

License and Copyright

All code is offered under the MIT license, unless otherwise noted. Please see LICENSE.txt for the full license. All code and documentation are Copyright 2015 to present, Chris Jones unless otherwise noted.

Contributing

I would love for someone to make a branch and start editing some code. My Objective-C skills leave a lot to be desired. So if you have a great idea, don't hesitate to download the code and contribute. There is a guide for contributing, here

Contributing > Maintenance

To fix vulnerable pods or various pages GitHub find vulnerable

pod outdated
echo "update outdated pods"
pod install [OUTDATED_POD]

Contributing > Troubleshooting

Reverting from nuclear 🤯 git changes

Workaround > git

god forbid‚™️ I merge then push a branch into master that I did not mean to, perform the below steps

git reset --hard [tag/branch/commit id]
echo "reset local working branch, ie. [master] to one of the specified fields"
git push [remote(s)] -f
echo "[remote] can be `origin` or `upstream`"
echo "NOTE: the above two step should revert a brach local and remote from nuclear changes"

Contributing > Website

http://ipatch.github.io/KegCop/

There is a git branch gh-pages-src that contains a node project to build a website using github pages for the aboe listed URL, that branch src does not correlate to the main objc src for the actual iOS app, but only serves a purpose to be the directory / src for the accompanying website.

Installation

  • Clone this repo, then build for your device using Xcode.
  • Load the following sketch on your Bluno, from here

cheers 🍻

@ipatch
@truckmonth

About

🍻 An iOS app monitoring kegerators using BLE (Bluetooth 4.0) communicating to a microcontroller.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages