README.md

FareBot

View your remaining balance, recent trips, and other information from contactless public transit cards using your NFC Android phone!

Written By

• Eric Butler [email protected]

Thanks To

• Karl Koscher (ORCA)
• Sean Cross (CEPAS/EZ-Link)
• Anonymous Contributor (Clipper)
• nfc-felica and IC SFCard Fan projects (Suica)
• Wilbert Duijvenvoorde (MIFARE Classic/OV-chipkaart)
• tbonang (NETS FlashPay)
• Marcelo Liberato (Bilhete Único)
• Lauri Andler (HSL)
• Michael Farrell (Opal, Manly Fast Ferry, Go card, Myki, Octopus)
• Rob O'Regan (Manly Fast Ferry card image)
• b33f (EasyCard)
• Bondan Sumbodo (Kartu Multi Trip, COMMET)

License

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Supported Protocols

• CEPAS (Not compatible with all devices)
• FeliCa
• MIFARE Classic (Not compatible with all devices)
• MIFARE DESFire
• MIFARE Ultralight (Not compatible with all devices)

Supported Cards

• Clipper - San Francisco, CA, USA
• EZ-Link - Singapore (Not compatible with all devices)
• Myki - Melbourne (and surrounds), VIC, Australia (Only the card number can be read)
• Matkakortti, HSL - Finland
• NETS FlashPay - Singapore
• Octopus - Hong Kong
• Opal - Sydney (and surrounds), NSW, Australia
• ORCA - Seattle, WA, USA
• Suica, ICOCA, PASMO, Edy - Japan
• Kartu Multi Trip - Jakarta, Indonesia (Only for new FeliCa cards)

Supported Cards (Keys Required)

These cards require that you crack the encryption key (using a proxmark3 or mfcuk+mfoc) and are not compatible with all devices.

• Bilhete Único - São Paulo, Brazil
• Go card (Translink) - Brisbane and South East Queensland, Australia
• Manly Fast Ferry - Sydney, Australia
• OV-chipkaart - Netherlands
• EasyCard - Taipei (Older insecure cards only)

Supported Phones

FareBot requires an NFC Android phone running 5.0 or later.

Building

$ git clone https://github.com/codebutler/farebot.git
$ cd farebot
$ git submodule update --init
$ ./gradlew assembleDebug

Open Source Libraries

FareBot uses the following open-source libraries:

• AutoDispose
• AutoValue
• AutoValue Gson
• Dagger
• Gson
• Guava
• Kotlin
• Magellan
• RxBroadcast
• RxJava
• RxRelay