https://github.com/metrodroid/metrodroid

Read data from public transit cards using your NFC Android phone! (iOS 13 and PC/SC support coming soon)
https://github.com/metrodroid/metrodroid
android cepas felica ios iphone iso14443a mifare mifare-classic mifare-desfire mifare-ultralight nfc pcsc public-transport suica
Last synced: 22 days ago
JSON representation
Read data from public transit cards using your NFC Android phone! (iOS 13 and PC/SC support coming soon)
Host: GitHub
URL: https://github.com/metrodroid/metrodroid
Owner: metrodroid
License: gpl-3.0
Created: 2015-07-02T13:10:08.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2025-02-01T15:01:59.000Z (2 months ago)
Last Synced: 2025-02-01T16:19:53.631Z (2 months ago)
Topics: android, cepas, felica, ios, iphone, iso14443a, mifare, mifare-classic, mifare-desfire, mifare-ultralight, nfc, pcsc, public-transport, suica
Language: Kotlin
Homepage: https://www.metrodroid.org
Size: 67.1 MB
Stars: 546
Watchers: 22
Forks: 74
Open Issues: 62
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: COPYING
Awesome Lists containing this project

awesome - metrodroid/metrodroid - Read data from public transit cards using your NFC Android phone! (iOS 13 and PC/SC support coming soon) (Kotlin)
mobile-awesome - metrodroid - Read data from public transit cards using your NFC Android phone! (iOS 13 and PC/SC support coming soon). (Android / Android samples)
README

        # ![logo](https://github.com/metrodroid/metrodroid/raw/master/src/main/res/mipmap-hdpi/ic_launcher.png) [Metrodroid](https://github.com/metrodroid/metrodroid)

[![Translation status](https://hosted.weblate.org/widgets/metrodroid/-/svg-badge.svg)][weblate] [![Build Status](https://travis-ci.org/metrodroid/metrodroid.svg?branch=master)][travis]









Direct APK download

iOS version coming soon!

Version: 3.0.xx

View remaining balance, recent trips, and other info from contactless public transit

cards using NFC on Android and [iOS (coming soon)][ios].

* [Michael Farrell](https://github.com/micolous)

View the presentation of work undergone to support a number of Australian agencies' cards, given at

linux.conf.au 2018, in the talk _[Tap on to reverse engineering](https://youtu.be/qVvNdfKRw7M)_.

## Thanks to

* [Eric Butler][5] (Farebot, on which this project is based)

* [Karl Koscher][3] (ORCA)

* [Sean Cross][4] (CEPAS/EZ-Link)

* Anonymous Contributor (Clipper)

* [nfc-felica][13] and [IC SFCard Fan][14] projects (Suica)

* [Chris Norden](https://github.com/cnorden) (Edy)

* [Wilbert Duijvenvoorde](https://github.com/wandcode) (MIFARE Classic/OV-chipkaart)

* [tbonang](https://github.com/tbonang) (NETS FlashPay)

* [Marcelo Liberato](https://github.com/mliberato) (Bilhete Único)

* [Lauri Andler](https://github.com/landler/) (HSL)

* [Michael](https://github.com/micolous/) (Opal, Manly Fast Ferry, Go card, Myki, Octopus, Cubic Nextfare, LAX TAP, SmartRider, MyWay, MIFARE Ultralight, ERG, Christchurch Metrocard)

* [Steven Steiner](https://github.com/steets250) (LAX TAP)

* [Rob O'Regan](https://www.robx1.net/nswtkt/private/manlyff/manlyff.htm) (Manly Fast Ferry card image)

* [The Noun Project][15] (Various icons)

* [Vladimir Serbinenko](https://github.com/phcoder) (Podorozhnik, Troika, Compass, Shenzhen Tong, Rav-Kav, T-money, Leap, CharlieCard, EN1545, Intercode, IstanbulKart, Lisboa Viva, Mobib, RicaricaMi, Chinese cards, Adelaide Metrocard, Rejsekort)

* [Toomas Losin](http://www.lenrek.net) (Compass)

* [Sinpo Lib](https://github.com/sinpolib) (Shenzhen Tong)

* Maria Komar (Podorozhnik database and dumps)

* [Bondan](https://github.com/sybond) [Sumbodo](http://sybond.web.id) (Kartu Multi Trip, MRT Jakarta)

## Translated by

Thanks to those who have [helped to make Metrodroid available in languages other than English][weblate]:

* Dutch: [Vistaus](https://github.com/Vistaus)

* Finnish: Lari Oesch, Lauri Andler

* French: [Albirew](https://github.com/Albirew)

* Hebrew: [Steven Steiner](https://github.com/steets250), [Yaron Shahrabani](https://github.com/yarons)

* Indonesian: [Bondan](https://github.com/sybond) [Sumbodo](http://sybond.web.id)

* Japanese: [naofum](https://github.com/naofum), [Chris Norden](https://github.com/cnorden), [Eric Butler][5]

* Kabyle: [belkacem77](https://github.com/belkacem77), [aqvayli](https://github.com/aqvayli)

* Norwegian Bokmål: [Allan Nordhøy](https://github.com/comradekingu), [Petter Reinholdtsen](https://github.com/petterreinholdtsen)

* Portuguese (Brazil): [Marlon Colhado](https://github.com/MarlonColhado)

* Russian: [Vladimir Serbinenko](https://github.com/phcoder)

* Spanish: [NokisDemox](https://github.com/NokisDemox)

* Turkish: [omersiar](https://github.com/omersiar)

## Supported card protocols

* [FeliCa][felica]

* [FeliCa Lite][felica]

* ISO/IEC 7816-4

  * [Calypso][calypso]

  * [CEPAS][cepas]

  * [T-Money][tmoney]

* [ISO/IEC 15693 "Vicinity"][nfcv]

* [MIFARE Classic][mfc] (Not compatible with all devices)

* [MIFARE DESFire][mfd]

* [MIFARE Ultralight][mfu] (Not compatible with all devices)

## Supported cards / agencies

Card / Agency | Location | Notes

------------- | -------- | -----

[Amiibo][amiibo] | :earth_asia: _worldwide_ | :new: `IOS`

[AT HOP][athop] | :new_zealand: Auckland, New Zealand | :new: :id: `IOS`

[Beijing Municipal Card][beijing] | :cn: Beijing, China | :new:

[bip!][bip] | :chile: Santiago de Chile, Chile | :new: :closed_lock_with_key: `MFC`

[Bilhete Único][bu] | :brazil: São Paulo, Brazil | :closed_lock_with_key: `MFC`

[BUS-IT][busit] | :new_zealand: Greater Hamilton (Waikato), New Zealand | :new: :closed_lock_with_key: `MFC`

[Carta Mobile][pisa] | :it: Pisa, Italy | :new: `IOS`

[CharlieCard][charlie] | :us: Boston, MA, USA | :new: :closed_lock_with_key: `MFC`

Cifial | :earth_africa: _worldwide_ | :new: `MFC`

City Union | :cn: Mainland China | :new: `IOS`

[Clipper][clipper] | :us: San Francisco, CA, USA | `IOS`

[Compass][compass] | :canada: Vancouver, BC, Canada | :new: :one: `IOS`

[Crimea Trolleybus][crimea] | Crimea | :new: :closed_lock_with_key: `MFC`

[Cubic Nextfare][nextfare] | :earth_americas: _many locations_ | :new: :closed_lock_with_key: `MFC`

[EasyCard][easycard] | Taipei | :closed_lock_with_key: `MFC`

[Edy][edy] | :jp: Japan

[Ekarta][ekarta] | :ru: Ekaterinburg, Russia | :new: :closed_lock_with_key: `MFC`

[Electronic Barnaul][barnaul] | :ru: Barnaul, Russia | :new: :closed_lock_with_key: `MFC`

[EMV][emv] | :earth_africa: _worldwide_ | :new:

[Envibus][envibus] | :fr: Sophia Antipolis, France | :new: `IOS`

[ERG][erg] | :earth_asia: _many locations_ | :new: :closed_lock_with_key: `MFC`

[EZ-Link][ezlink] | :singapore: Singapore |

[Go card][seqgo] | :australia: Brisbane and South East Queensland, Australia | :new: :closed_lock_with_key: `MFC`

[GoCard][otago] | :new_zealand: Otago, including Greater Dunedin and Queenstown, New Zealand | :new: `MFC`

[Go-to card][mspgoto] | :us: Minneapolis-St. Paul, MN, USA | :new: :closed_lock_with_key: `MFC`

[Hafilat][] | :united_arab_emirates: Abu Dhabi, UAE | :new: `IOS`

[HOLO][holo] | :us: Oʻahu, HI, USA | :new: :id: `IOS`

[Hop Fastpass][hfp] | :us: Portland, OR, USA | :new: :id: `IOS`

[HSL][hsl], [Matkakortti][matka], [Waltti][] | :finland: Finland | `IOS`

[IstanbulKart][istanbul] | :tr: Istanbul, Turkey | :new: :id: `IOS`

[Kartu Multi Trip][kmt] | :indonesia: Jakarta, Indonesia | `KMT` `IOS`

[Kazan transport card][kazan] | :ru: Kazan, Russia | :new: :closed_lock_with_key: `MFC`

[Kiev Metro][kievm] | :ukraine: Kiev, Ukraine | :new: :closed_lock_with_key: `MFC`

[Kirov transport card][kirov] | :ru: Kirov, Russia | :new: :closed_lock_with_key: `MFC`

[KomuterLink][komuterlink] | :malaysia: Malaysia | :new: :closed_lock_with_key: `MFC`

[Krasnodar ETK][krasnodar] | :ru: Krasnodar, Russia | :new: :closed_lock_with_key: `MFC`

[Leap][leap] | :ireland: Ireland | :new: :unlock:

[Lisboa Viva][lisboa] | :portugal: Lisbon, Portugal | :new: `IOS`

[Manly Fast Ferry][manly] | :australia: Sydney, NSW, Australia | :new: :closed_lock_with_key: `MFC`

[Metrocard][adl] | :australia: Adelaide, SA, Australia | :new: `IOS`

[Metrocard][chc] | :new_zealand: Christchurch, New Zealand | :new: :closed_lock_with_key: `MFC`

[Metromoney][tbs] | :georgia: Tbilisi, Georgia | :new: :closed_lock_with_key: `MFC`

[Mobib][mobib] | :belgium: Belgium | :new: `IOS`

[MRT Jakarta][mrtj] | :indonesia: Jakarta, Indonesia | :new:

[Myki][myki] | :australia: Melbourne (and surrounds), VIC, Australia | :new: :id: `IOS`

[MyWay][myway] | :australia: Australian Capital Territory, Australia | :new: :closed_lock_with_key: `MFC`

[Navigo][navigo] | :fr: Paris, France | :new: `IOS`

[NETS FlashPay][nets] | :singapore: Singapore |

[Nol][] | :united_arab_emirates: Dubai, UAE | :new: :id: `IOS`

[Octopus][octopus] | :hong_kong: Hong Kong | :new: `IOS`

[Opal][opal] | :australia: Sydney (and surrounds), NSW, Australia | :new: `IOS`

[Opus][opus] | :canada: Québec, Canada | :new: `IOS`

[ORCA][orca] | :us: Seattle, WA, USA | `IOS`

[Orenburg EKG][orenburg] | :ru: Orenburg, Russia | :new: :closed_lock_with_key: `MFC`

[OùRA][oura] | :fr: Grenoble, France | :new: `IOS`

[OV-chipkaart][ovc] | :netherlands: Netherlands | :closed_lock_with_key: `MFC`

[Oyster][oyster] | :gb: London, United Kingdom | :new: :closed_lock_with_key: `MFC`

Penza transport card | :ru: Penza, Russia | :new: :closed_lock_with_key: `MFC`

[Podorozhnik][podoro] | :ru: Saint Petersburg, Russia | :new: :closed_lock_with_key: `MFC`

[Rav-Kav][ravkav] | :israel: Israel | :new: `IOS`

[Rejsekort][rejse] | :denmark: Denmark | :new: :closed_lock_with_key: `MFC`

[RicaricaMi][ricarica] | :it: Milan, Italy | :new: :closed_lock_with_key: `MFC`

[Samara ETK][samara] | :ru: Samara, Russia | :new: :closed_lock_with_key: `MFC`

[Selecta][] | :fr: France | :new: `MFC`

[Shenzhen Tong][shenzhen] | :cn: Shenzhen, Guangdong Province, China | :new: `IOS`

[Siticard][siticard] | :ru: Nizhniy Novgorod, Russia | :new: :closed_lock_with_key: `MFC`

[SLAccess][slaccess] | :sweden: Stockholm, Sweden | :new: :closed_lock_with_key: `MFC`

[Smartride][smartride] | :new_zealand: Rotorua, New Zealand | :new: `MFC`

[SmartRider][smartrider] | :australia: Western Australia, Australia | :new: :closed_lock_with_key: `MFC`

[Snapper][snapper] | :new_zealand: Wellington, New Zealand | :new: `IOS`

[Strelka][strelka] | :ru: Moscow, Russia | :closed_lock_with_key: :id: `MFC`

[Strizh][strizh] | :ru: Izhevsk, Russia | :new: :closed_lock_with_key: `MFC`

[Suica][suica], [ICOCA][icoca], [PASMO][pasmo] | :jp: Japan |

[SunCard][suncard] | :us: Orlando, FL, USA | :new: :closed_lock_with_key: :id: `MFC`

[TaM][tam] | :fr: Montpellier, France | :new: `IOS`

[Tartu Bus][tartu] | :estonia: Tartu, Estonia | :new: :id: `MFC`

[T-Money][tmoney] | :kr: South Korea | :new: `IOS`

[TPF card][tpf] | :switzerland: Fribourg, Switzerland | :new: :id:

[TransGironde][gironde] | :fr: Gironde, France | :new: `IOS`

[Transit Access Pass][laxtap] | :us: Los Angeles, CA, USA | :new: :closed_lock_with_key: `MFC`

[Troika][troika] | :ru: Moscow, Russia | :new: :closed_lock_with_key: `MFC`

T-Union | :cn: Mainland China | :new: `IOS`

[Umarsh][umarsh] | :ru: _multiple cities in Russia_ | :new: :closed_lock_with_key: `MFC`

[Ventra][ventra] | :us: Chicago, IL, USA | :new: :one: `IOS`

[Warszawska Karta Miejska][warsaw] | :poland: Warsaw, Poland | :new: :id: :closed_lock_with_key: `MFC`

[Wuhan Tong][wuhan] | :cn: Wuhan, Hubei Province, China | :new: `IOS`

[Yaroslavl ETK][yaroslavl] | :ru: Yaroslavl, Russia | :new: :closed_lock_with_key: `MFC`

[Yoshkar-Ola][yolatrans] | :ru: Yoshkar-Ola, Russia | :new: :closed_lock_with_key: `MFC`

[Zolotaya Korona][zolotaya] | :ru: _multiple cities in Russia_ | :new: :closed_lock_with_key: `MFC`

Note                   | Meaning

---------------------- | -------

:new:                  | New in Metrodroid.

:closed_lock_with_key: | Encryption keys required to read this card.

:unlock:               | Encryption keys are downloaded from the operator.

:ireland:              | [Leap not yet supported on iOS][ios].

:jp:                   | [FeliCa cards with more than 1 system not supported on iOS][ios].

:singapore:            | CEPAS cards (Singapore) are not compatible with all devices (ISO 14443-B). [Not supported on iOS][ios].

`MFC`                  | MIFARE Classic card; requires NXP NFC chipset in your device. [Not supported on iOS][ios].

:id:                   | Only the card number can be read.

`KMT`                  | Only new FeliCa-based cards can be read.

:one:                  | Only single-use tickets can be read.

`IOS`                  | Supported on [Metrodroid for iOS][ios].

This project **will only read data from the card itself**, without having to

connect to the agency's back-office systems. In some cases, limited data is

available, so balance information and trip history might not be available.

Note: The Leap card reader connects to Transport for Ireland's server for

challenge-response authentication with the card. The data is otherwise

interpreted locally, and _connectivity is disabled by default._

## Supported devices

**Metrodroid for Android** requires Android 4.1 or later, with NFC support.

Some devices do not support MIFARE Classic. MIFARE Classic is not an NFC-compliant card format, so they can only be read on devices with NXP chipsets.

**Metrodroid for iOS** requires iOS 13.0 or later, and iPhone 7 or later. It does not support other

iOS devices, even those that support Apple Pay.

## License and copyright

Copyright © 2015–2019 Michael Farrell

Copyright © 2011–2013 Eric Butler

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 .

This program contains Leaflet, a JavaScript mapping library, licensed under the BSD license.

This software and it's authors are not associated with any public transit agency. Pictures of supported cards, including their logos, are included with this software package for the purposes of identifying cards.

## Building / hacking on this software

1. Clone the repository including submodules:

   ```

   $ git clone --recursive https://github.com/metrodroid/metrodroid.git

   ```

   [If you get an error from Gradle about `:material-design-icons` not being available, then your

   clone doesn't have the submodules.](https://github.com/metrodroid/metrodroid/issues/32)

   ZIP source code downloads from GitHub's web interface **will not work**!

2. Import the directory into Android Studio.

   Android Studio will prompt you to install the appropriate SDK version, build tools, and Gradle.

[3]: https://twitter.com/supersat

[4]: https://twitter.com/xobs

[5]: https://twitter.com/codebutler

[13]: https://github.com/Kazzz/nfc-felica

[14]: http://www014.upp.so-net.ne.jp/SFCardFan/

[15]: https://www.thenounproject.com/

[weblate]: https://hosted.weblate.org/engage/metrodroid/

[travis]: https://travis-ci.org/metrodroid/metrodroid

[calypso]: http://www.calypsotechnology.net/

[cepas]: https://en.wikipedia.org/wiki/CEPAS

[felica]: https://en.wikipedia.org/wiki/FeliCa

[nfcv]: https://en.wikipedia.org/wiki/ISO/IEC_15693

[mfc]: https://en.wikipedia.org/wiki/MIFARE#MIFARE_Classic

[mfd]: https://en.wikipedia.org/wiki/MIFARE#MIFARE_DESFire

[mfu]: https://en.wikipedia.org/wiki/MIFARE#MIFARE_Ultralight_and_MIFARE_Ultralight_EV1

[ios]: https://www.metrodroid.org/metrodroid/ios

[adl]: https://adelaidemetro.com.au/Tickets-fares/metroCARD

[amiibo]: https://www.nintendo.com/amiibo/

[athop]: https://at.govt.nz/bus-train-ferry/at-hop-card/

[barnaul]: https://barnaul.org/

[beijing]: https://en.wikipedia.org/wiki/Yikatong

[bip]: http://www.tarjetabip.cl/

[bu]: http://bilheteunico.sptrans.com.br/

[busit]: https://www.busit.co.nz/

[charlie]: https://www.mbta.com/fares/charliecard

[chc]: http://www.metroinfo.co.nz/

[clipper]: https://www.clippercard.com/

[compass]: https://www.compasscard.ca/

[crimea]: http://crimeatroll.ru/

[easycard]: https://www.easycard.com.tw/en/

[edy]: https://en.wikipedia.org/wiki/Edy

[ekarta]: http://ekarta-ek.ru/

[emv]: https://en.wikipedia.org/wiki/EMV

[envibus]: http://www.envibus.fr/

[erg]: https://github.com/metrodroid/metrodroid/wiki/ERG-MFC

[ezlink]: http://www.ezlink.com.sg/

[gironde]: https://www.transgironde.fr/

[hafilat]: https://dot.abudhabi.ae/en/mediainfo/hafilat_smart_card

[hfp]: https://myhopcard.com/

[holo]: https://www.holocard.net/

[hsl]: https://www.hsl.fi/EN/

[icoca]: https://en.wikipedia.org/wiki/ICOCA

[istanbul]: https://www.istanbulkart.istanbul/

[kazan]: http://transkart.ru/

[kievm]: http://www.metro.kyiv.ua/

[kirov]: http://www.mo-kirov.ru/gorozhanam/transport/

[kmt]: https://en.wikipedia.org/wiki/Kereta_Commuter_Indonesia

[komuterlink]: http://www.ktmb.com.my/KomuterLink.html

[krasnodar]: https://t-karta.ru/Cards/Krasnodar

[laxtap]: https://www.taptogo.net/

[leap]: https://www.leapcard.ie/

[lisboa]: https://www.portalviva.pt/

[manly]: http://www.manlyfastferry.com.au/

[matka]: http://www.hsl.fi/EN/passengersguide/travelcard/Pages/default.aspx

[mobib]: https://mobib.be/

[mrtj]: https://www.jakartamrt.co.id/

[mspgoto]: https://www.metrotransit.org/go-to-card

[myki]: http://ptv.vic.gov.au/

[myway]: https://www.transport.act.gov.au/myway-and-fares

[navigo]: http://www.navigo.fr/

[nets]: http://www.netsflashpay.com.sg/

[nextfare]: https://github.com/metrodroid/metrodroid/wiki/Cubic-Nextfare-MFC

[nol]: https://www.nol.ae/

[octopus]: http://www.octopus.com.hk/home/en/index.html

[opal]: http://www.opal.com.au/

[opus]: http://www.stm.info/en/info/fares/opus-cards-and-other-fare-media/opus-card

[orca]: http://www.orcacard.com/

[orenburg]: https://t-karta.ru/Cards/Orenburg

[otago]: https://www.orc.govt.nz/public-transport/dunedin-buses/fares-and-gocard

[oura]: https://www.oura.com/

[ovc]: http://www.ov-chipkaart.nl/

[oyster]: https://oyster.tfl.gov.uk/

[pasmo]: https://en.wikipedia.org/wiki/PASMO

[pisa]: http://www.pisa.cttnord.it/Carta_Mobile/P/561

[podoro]: http://podorozhnik.spb.ru/en/

[ravkav]: https://www.rail.co.il/en/ravkav/Pages/default.aspx

[rejse]: https://www.rejsekort.dk/

[ricarica]: https://www.atm.it/en/ViaggiaConNoi/Biglietti/Pages/TesseraRIcaricaMI.aspx

[samara]: https://t-karta.ru/Cards/Samara

[selecta]: https://www.selecta.com/

[seqgo]: http://translink.com.au/tickets-and-fares/go-card

[shenzhen]: http://www.shenzhentong.com/

[siticard]: https://siticard.ru/

[slaccess]: https://sl.se/en/eng-info/fares/sl-access/

[smartride]: https://www.baybus.co.nz/faqs/smartride-card/

[smartrider]: http://www.transperth.wa.gov.au/SmartRider/

[snapper]: https://www.snapper.co.nz/

[strelka]: https://strelkacard.ru/

[strizh]: http://xn--c1aff6b0c.xn--p1ai/pages/karta-strizh/

[suica]: https://en.wikipedia.org/wiki/Suica

[suncard]: https://sunrail.com/tickets-suncards/suncards/

[tam]: http://www.tam-voyages.com/

[tartu]: https://www.tartu.ee/en/tartu-bus-card

[tbs]: http://ttc.com.ge/?lang_id=ENG&sec_id=155

[tmoney]: https://www.t-money.co.kr/

[tpf]: https://www.tpf.ch/abonnements-billets/tpf-card

[troika]: http://troika.mos.ru/

[umarsh]: https://umarsh.com/

[ventra]: https://www.ventrachicago.com/

[waltti]: https://waltti.fi/en/

[warsaw]: https://www.ztm.waw.pl/?c=557&l=1

[wuhan]: http://www.whcst.com/

[yaroslavl]: https://t-karta.ru/Cards/Yaroslavl

[yolatrans]: http://yolatrans.ru/

[zolotaya]: https://en.wikipedia.org/wiki/Zolotaya_Korona
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/metrodroid/metrodroid

Awesome Lists containing this project

README
