Skip to content

tylerbucher/socketcand-client

 
 

Repository files navigation

socketcand-client

GitHub build status Codeclimate coverage npm version npm downloads github license

An updated NodeJS client for socketcand daemon, based on zorce's socketcand-client.

Usage

Availible emitter enpoints are:

  • connectionPoints - Lists avalible connections options (Created from socketcand broadcasting packets).
  • data - Outputs raw frame data as recieved from a socektcand server (Only emits data when connected in raw mode).
  • frame - Outputs a parsed can frame obj from socketcand server(s) (Only emits data when connected in controlled mode).
  • connected - Ouputs a data object when this library connects to a socketcand server.
  • disconnected - Outputs a data object when this library disconnects from a socketcand server.

Example

import {connect, getEmitter, SocketPoint, start, ConnectionObj, FrameObj} from "@agent6262/socketcand-client";

getEmitter().on("connectionPoints", function (points: Array<SocketPoint>) {
    console.log(points);

    let exampleStr = "can0@host (can://127.0.0.1:12345)";
    let id = connect(exampleStr, ConnectionMode.CONTROLLED);
});

getEmitter().on("frame", (frame: FrameObj) => {
    console.log(frame);
});

getEmitter().on("connected", function (conn: ConnectionObj) {});

getEmitter().on("disconnected", function (data: ConnectionObj) {
    console.log("CLOSED");
});

getEmitter().on("data", function (data: string) {
    console.log(data);
});

start();

Refrences

About

A NodeJS client for socketcand daemon

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.6%
  • JavaScript 0.4%