{"id":30115555,"url":"https://github.com/meshcore-dev/meshcore.js","last_synced_at":"2025-08-10T08:23:19.359Z","repository":{"id":277257424,"uuid":"930501898","full_name":"meshcore-dev/meshcore.js","owner":"meshcore-dev","description":null,"archived":false,"fork":false,"pushed_at":"2025-06-20T04:23:59.000Z","size":272,"stargazers_count":9,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-06T10:43:43.707Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/meshcore-dev.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,"zenodo":null}},"created_at":"2025-02-10T18:28:05.000Z","updated_at":"2025-08-06T02:20:37.000Z","dependencies_parsed_at":"2025-06-20T05:30:04.996Z","dependency_job_id":null,"html_url":"https://github.com/meshcore-dev/meshcore.js","commit_stats":null,"previous_names":["liamcottle/meshcore.js","meshcore-dev/meshcore.js"],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/meshcore-dev/meshcore.js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meshcore-dev%2Fmeshcore.js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meshcore-dev%2Fmeshcore.js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meshcore-dev%2Fmeshcore.js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meshcore-dev%2Fmeshcore.js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/meshcore-dev","download_url":"https://codeload.github.com/meshcore-dev/meshcore.js/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meshcore-dev%2Fmeshcore.js/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269694069,"owners_count":24460342,"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-08-10T02:00:08.965Z","response_time":71,"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":[],"created_at":"2025-08-10T08:23:18.053Z","updated_at":"2025-08-10T08:23:19.349Z","avatar_url":"https://github.com/meshcore-dev.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MeshCore.js\n\nA Javascript library for interacting with a [MeshCore](https://github.com/ripplebiz/MeshCore) device running the [Companion Radio Firmware](https://github.com/ripplebiz/MeshCore/blob/main/examples/companion_radio/main.cpp).\n\nThis library can be used in a Web Browser to connect to MeshCore Companion devices over BLE or USB Serial.\n\nIt can also be used in NodeJS to connect to MeshCore Companion devices over TCP/WiFi or USB Serial.\n\n## Supported Connection Methods\n\n- Web Browser\n    - BLE: [WebBleConnection()](./src/connection/web_ble_connection.js)\n    - USB/Serial: [WebSerialConnection()](./src/connection/web_serial_connection.js)\n- NodeJS\n    - TCP/WiFi: [TCPConnection(\"host\", \"port\")](./src/connection/tcp_connection.js)\n    - USB/Serial: [NodeJSSerialConnection(\"/dev/ttyUSB0\")](./src/connection/nodejs_serial_connection.js)\n\n## Install\n\n```\nnpm install @liamcottle/meshcore.js\n```\n\n## Simple Example\n\n```\nimport { TCPConnection, NodeJSSerialConnection } from \"@liamcottle/meshcore.js\";\n\n// serial connections are supported by \"companion_radio_usb\" firmware\nconst connection = new NodeJSSerialConnection(\"/dev/cu.usbmodem14401\");\n\n// tcp connections are supported by \"companion_radio_wifi\" firmware\n// const connection = new TCPConnection(\"10.1.0.226\", 5000);\n\n// wait until connected\nconnection.on(\"connected\", async () =\u003e {\n\n    // we are now connected\n    console.log(\"connected!\");\n\n    // log contacts\n    const contacts = await connection.getContacts();\n    for(const contact of contacts) {\n        console.log(`Contact: ${contact.advName}`);\n    }\n\n    // disconnect\n    connection.close();\n\n});\n\n// connect to meshcore device\nawait connection.connect();\n```\n\n## Examples\n\nThere's a few other examples scripts in the [examples](./examples) folder.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeshcore-dev%2Fmeshcore.js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmeshcore-dev%2Fmeshcore.js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeshcore-dev%2Fmeshcore.js/lists"}