{"id":20393393,"url":"https://github.com/birkir/ovms-client","last_synced_at":"2025-09-12T03:36:06.380Z","repository":{"id":44973100,"uuid":"228435962","full_name":"birkir/ovms-client","owner":"birkir","description":"OVMS client written in TypeScript","archived":false,"fork":false,"pushed_at":"2023-09-11T10:19:33.000Z","size":1857,"stargazers_count":2,"open_issues_count":16,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2023-09-11T11:35:11.235Z","etag":null,"topics":["client","obdii","ovms","typescript"],"latest_commit_sha":null,"homepage":null,"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/birkir.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":"2019-12-16T17:08:40.000Z","updated_at":"2023-09-11T10:19:37.000Z","dependencies_parsed_at":"2023-02-03T07:45:27.594Z","dependency_job_id":null,"html_url":"https://github.com/birkir/ovms-client","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/birkir%2Fovms-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/birkir%2Fovms-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/birkir%2Fovms-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/birkir%2Fovms-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/birkir","download_url":"https://codeload.github.com/birkir/ovms-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224727131,"owners_count":17359533,"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":["client","obdii","ovms","typescript"],"created_at":"2024-11-15T03:48:34.150Z","updated_at":"2024-11-15T03:48:34.769Z","avatar_url":"https://github.com/birkir.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OVMS Client\n\nThis is a simple OVMS client written for NodeJS.\n\n## Usage\n\n```js\nconst { OVMSClient } = require('ovms-client');\n\n// host, port, vehicle id, password\nconst client = new OVMSClient('api.openvehicles.com', 6867, 'DEMO', 'DEMO');\n// Note: commands won't work with the DEMO vehicle\n\n// connect\nclient.connect();\n\n// subscribe to specific messages:\n//   status,location,firmware,environment,tpms\n//   serverAck,commandReceived,pushNotification\n//   carsConnected,lastUpdated\nclient.on('status', status =\u003e {\n  console.log('status', status);\n});\n\n// raw messages\nclient.on('raw', msg =\u003e {\n  console.log('raw message', msg);\n})\n\n// command responses:\nclient.on('commandReceived', response =\u003e {\n  // see https://docs.openvehicles.com/en/latest/protocol_v2/messages.html#command-response-0x63-c\n  let [ command, result, message ] = response.split(',');\n  console.log('command', command, 'result', result);\n  if (message) {\n    console.log(message.replace(/\\r/g, String.fromCharCode(10)));\n  }\n});\n\n// wait for connection:\nclient.on('connected', callback =\u003e {\n\n  // Send a ping\n  // (see https://docs.openvehicles.com/en/latest/protocol_v2/messages.html)\n  client.sendRaw('MP-0 A');\n\n  // Send a shell command\n  // (see https://docs.openvehicles.com/en/latest/protocol_v2/commands.html)\n  client.send('7,stat');\n\n  // Send a lock command using PIN 1234\n  client.send('20,1234');\n\n});\n```\n\n## Contribute\n\nFeel free to send pull-requests\n\n## License\n\nMIT","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbirkir%2Fovms-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbirkir%2Fovms-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbirkir%2Fovms-client/lists"}