https://github.com/ryleeharrison/canfetti
A Node.js library for GS_USB devices, supporting CANtact, CANable, and CANalyze adapters. Designed with seamless MacOS compatibility in mind, it provides a simple and efficient interface for CAN Bus communication.
https://github.com/ryleeharrison/canfetti
Last synced: 3 months ago
JSON representation
A Node.js library for GS_USB devices, supporting CANtact, CANable, and CANalyze adapters. Designed with seamless MacOS compatibility in mind, it provides a simple and efficient interface for CAN Bus communication.
- Host: GitHub
- URL: https://github.com/ryleeharrison/canfetti
- Owner: RyLeeHarrison
- License: mit
- Created: 2025-01-19T03:13:11.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-01-19T03:37:55.000Z (3 months ago)
- Last Synced: 2025-01-19T04:24:00.893Z (3 months ago)
- Language: JavaScript
- Size: 409 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🎉 CANfetti 🎉
A Node.js library for GS\_USB devices, supporting CANtact, CANable, and CANalyze adapters. Designed specifically with macOS compatibility in mind, it provides a simple and efficient interface for CAN Bus communication.
## Installation
Install CANfetti via npm:
```bash
npm install canfetti
```
Or via yarn:
```bash
yarn install canfetti
```
## I put some examples in /Examples
## Features
- **macOS Support**: Exclusively designed for seamless operation on macOS.
- **Plug-and-Play**: Easy setup with common CAN Bus adapters.
- **Efficient Communication**: Provides a simple and streamlined interface for sending and receiving CAN messages.
## Requirements
To get started, you will need:
- A CAN Bus transceiver USB-to-CAN analyzer to interface with CAN Bus devices.
- Recommended device: [CANable](https://canable.io/). Search for "CANable" on Amazon.
## Contributing
I welcome contributions! Feel free to open issues or submit pull requests to enhance CANfetti.
## License
CANfetti is licensed under the MIT License. See the [LICENSE](https://github.com/RyLeeHarrison/CANfetti/blob/main/LICENSE) file for details.