{"id":16219998,"url":"https://github.com/kuba2k2/firefox-webserial","last_synced_at":"2025-10-10T13:31:58.531Z","repository":{"id":191726669,"uuid":"684771556","full_name":"kuba2k2/firefox-webserial","owner":"kuba2k2","description":"WebSerial API Polyfill for Mozilla Firefox browser","archived":false,"fork":false,"pushed_at":"2025-05-29T17:47:36.000Z","size":1907,"stargazers_count":135,"open_issues_count":15,"forks_count":10,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-05-29T18:53:31.330Z","etag":null,"topics":["esp32","esp8266","esptool-js","firefox","firefox-addon","firefox-extension","serial-port","webserial"],"latest_commit_sha":null,"homepage":"https://addons.mozilla.org/en-US/firefox/addon/webserial-for-firefox/","language":"TypeScript","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/kuba2k2.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-29T20:26:53.000Z","updated_at":"2025-05-29T17:47:40.000Z","dependencies_parsed_at":"2024-06-11T08:35:15.966Z","dependency_job_id":"b7b8ace3-a4fb-4344-a128-88d95bfdecb7","html_url":"https://github.com/kuba2k2/firefox-webserial","commit_stats":null,"previous_names":["kuba2k2/firefox-webserial"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/kuba2k2/firefox-webserial","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuba2k2%2Ffirefox-webserial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuba2k2%2Ffirefox-webserial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuba2k2%2Ffirefox-webserial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuba2k2%2Ffirefox-webserial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kuba2k2","download_url":"https://codeload.github.com/kuba2k2/firefox-webserial/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuba2k2%2Ffirefox-webserial/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279004062,"owners_count":26083667,"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","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["esp32","esp8266","esptool-js","firefox","firefox-addon","firefox-extension","serial-port","webserial"],"created_at":"2024-10-10T11:56:50.035Z","updated_at":"2025-10-10T13:31:58.175Z","avatar_url":"https://github.com/kuba2k2.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WebSerial for Firefox\n\nWebSerial API Polyfill for Mozilla Firefox browser\n\n## Introduction\n\nThis add-on allows to use the WebSerial API in Firefox.\n\nIt uses a native application to communicate with serial ports.\n\n**NOTE:** Currently, the add-on only works on Windows and Linux (x86-64).\n\n## Installation\n\nThe add-on is available for download from Mozilla Addons:\n[WebSerial for Firefox](https://addons.mozilla.org/pl/firefox/addon/webserial-for-firefox/).\n\nThe native application needs to be installed on the computer first. The GUI will offer to download the\nnative application when you first try to open a serial port.\n\n### Installation on Windows\n\nThe .exe file is an installer - just open it and install the native application.\n\n### Installation on Linux\n\nRun script:\n\n```sh\ncurl -s -L https://raw.githubusercontent.com/kuba2k2/firefox-webserial/master/native/install/linux_x86_64.sh | bash\n```\n\n#### or install manually\n\n1. Put the downloaded file in `~/.mozilla/native-messaging-hosts`\n2. Rename it to just `firefox-webserial`.\n3. Make it executable: `chmod +x ~/.mozilla/native-messaging-hosts/firefox-webserial`.\n4. Create a file named `io.github.kuba2k2.webserial.json` in the same directory, with this content:\n\t```json\n\t{\n\t\t\"name\": \"io.github.kuba2k2.webserial\",\n\t\t\"description\": \"WebSerial for Firefox\",\n\t\t\"path\": \"/home/USER/.mozilla/native-messaging-hosts/firefox-webserial\",\n\t\t\"type\": \"stdio\",\n\t\t\"allowed_extensions\": [\"webserial@kuba2k2.github.io\"]\n\t}\n\t```\n\tAdjust `/home/USER` to match your username.\n5. Restart the browser and use the extension.\n\n**NOTE:** On Alpine Linux (or other musl-based distros) you will need to have `gcompat` installed.\n\n## Usage\n\nSome applications that can work on Firefox with this add-on:\n\n- [Spacehuhn Serial Terminal](https://serial.huhn.me/)\n- [Google Chrome Labs Serial Terminal](https://googlechromelabs.github.io/serial-terminal/)\n- [ESPWebTool by Spacehuhn](https://esp.huhn.me/)\n- [ESP Tool by Espressif](https://espressif.github.io/esptool-js/)\n- [ESPHome Web](https://web.esphome.io/)\n- [ESP Web Tools by ESPHome](https://esphome.github.io/esp-web-tools/)\n- [NinjaTerm by Geoffrey Hunter](https://ninjaterm.mbedded.ninja/)\n\n## Debugging\n\nTo view logs produced by the extension for debugging purposes:\n\n- Open [about:debugging](about:debugging), click `This Firefox`\n- Find `WebSerial for Firefox`, click `Inspect`\n- Type in the console: `window.wsdebug = true`\n- Go to a website of choice, try connecting to a serial port - the console should show extension logs.\n\n## License\n\n```\nMIT License\n\nCopyright (c) 2023 Kuba Szczodrzyński\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkuba2k2%2Ffirefox-webserial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkuba2k2%2Ffirefox-webserial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkuba2k2%2Ffirefox-webserial/lists"}