{"id":24017812,"url":"https://github.com/m3m0r7/nfc-for-php","last_synced_at":"2025-04-15T16:21:31.950Z","repository":{"id":62521184,"uuid":"414970254","full_name":"m3m0r7/nfc-for-php","owner":"m3m0r7","description":"NFC Reader written in PHP","archived":false,"fork":false,"pushed_at":"2021-10-16T12:47:47.000Z","size":18926,"stargazers_count":28,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-11T11:26:28.925Z","etag":null,"topics":["ffi","nfc","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/m3m0r7.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-10-08T12:02:38.000Z","updated_at":"2024-12-16T15:59:36.000Z","dependencies_parsed_at":"2022-11-02T14:00:48.351Z","dependency_job_id":null,"html_url":"https://github.com/m3m0r7/nfc-for-php","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m3m0r7%2Fnfc-for-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m3m0r7%2Fnfc-for-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m3m0r7%2Fnfc-for-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m3m0r7%2Fnfc-for-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/m3m0r7","download_url":"https://codeload.github.com/m3m0r7/nfc-for-php/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249105476,"owners_count":21213537,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ffi","nfc","php"],"created_at":"2025-01-08T09:53:10.989Z","updated_at":"2025-04-15T16:21:31.924Z","avatar_url":"https://github.com/m3m0r7.png","language":"PHP","readme":"# What is nfc-for-php?\n\nThis library is a toy for me. You can read NFC with libnfc written in PHP.\n\n# Requirements\n- PHP 7.4+\n- PHP FFI\n- libnfc 1.8.0 (_if you use NFC reader for PaSoRi RC-S330_)\n- libusb 1.0.24 (_if you use NFC reader for PaSoRi RC-S380_)\n\n# Tested\n\n- OS\n  - Mac Big Sur\n  - RaspberryPi (Raspbian)\n- FeliCa\n  - PASMO\n  - Suica\n  - KONAMI e-AMUSEMENT pass\n  - Pixel5\n- PaSoRi RC-S330\n  - You **cannot** touch Apple Wallet on iOS\n  - https://www.amazon.co.jp/dp/B001MVPD8U/\n- PaSoRi RC-S380 (experimental)\n  - Supported only to a FeliCa\n  - You can touch Apple Wallet on iOS\n  - https://www.amazon.co.jp/dp/B00948CGAG/\n\n\u003cimg src=\"images/pasori.jpg\" /\u003e\n\n# Quick start\n\n## Mac\n### RC-S330\n1. Install libnfc\n\n```\n$ brew install libnfc\n```\n\n2. Install this library\n\n```\n$ composer require m3m0r7/nfc-for-php\n```\n\n3. Connect NFC Device into your machine.\n4. Run example code\n\n```\n$ cd /path/to/nfc-for-php\n$ php examples/nfc-poll-simple.php\n```\n\n5. Put your NFC\n\n\u003cimg src=\"images/felica.png\"\u003e\n\n6. You can get output.\n\n\u003cimg src=\"images/example.jpg\"\u003e\n\n### RC-S380\n\n1. Install libusb\n\n```\n$ brew install libusb\n```\n\n2. Install this library\n\n```\n$ composer require m3m0r7/nfc-for-php\n```\n\n3. Connect NFC Device into your machine.\n4. Run example code\n\n```\n$ cd /path/to/nfc-for-php\n$ php examples/rcs380-nfc-poll-simple.php\n```\n\n5. Put your NFC\n6. You can get output.\n\n# NFC binary\n\nWe're providing NFC binary in `vendor/bin`.\nAnd you can use 3 commands `start`, `ls` and `version`\n\n\n## start\n\nStart to listen NFC reader.\n\n```\n./vendor/bin/nfc start\n```\n\nYou can change the driver if you want to use other driver.\n\n```\n./vendor/bin/nfc start -D DriverName\n```\n\nYou can specify hook events in CLI command.\n\n```\n./vendor/bin/nfc start -E /path/to/events.php\n```\n\nFor example, you can use example file.\n\n```\n./vendor/bin/nfc start -E ./vendor/m3m0r7/nfc-for-php/examples/event-manager.php\n```\n\n\nAnd you want to more details, please run below command.\n\n```\n./vendor/bin/nfc start --help\n```\n\n## ls\n\nShow available devices.\n\n```\n./vendor/bin/nfc ls\n```\n\nYou can change the driver if you want to use other driver.\n\n```\n./vendor/bin/nfc ls -D DriverName\n```\n\nAnd you want to more details, please run below command.\n\n```\n./vendor/bin/nfc ls --help\n```\n\n## version\n\nShow PHP driver version.\n\n```\n./vendor/bin/nfc version\n```\n\nYou can change the driver if you want to use other driver.\n\n```\n./vendor/bin/nfc version -D DriverName\n```\n\nAnd you want to more details, please run below command.\n\n```\n./vendor/bin/nfc version --help\n```\n\n# How to use\n\n- See examples\n\n# Troubleshooting\n\n## Q. How to recognize a device?\nA. You must have granted permission to user.\nI already test on RaspberryPI (Raspbian), it should grant to access permission to `/dev/*` or using super user (e.g., the root user).\nIf you did not have permissions, cannot recognize a device on your environment and the libusb return an error `LIBUSB_ERROR_ACCESS`.\n\n## Q. Cannot start second time or later on macOS\nA. You must reconnect the connected USB plug because libnfc/libusb return an invalid packet in the macOS when second time or later.\nI don't know how to fix it.\n\n# License\n- MIT\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm3m0r7%2Fnfc-for-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fm3m0r7%2Fnfc-for-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm3m0r7%2Fnfc-for-php/lists"}