node-carplay
v4.1.0
Published
Carplay dongle driver for Node.js & Browser
Downloads
50
Readme
Join us on Slack
https://join.slack.com/t/automotive-pis/shared_invite/zt-27n3manj4-v0Q35NWPyHUAtrHl7sScjQ
About The Project
This repository contains the npm package node-carplay
that can be used on the Web or in Node.js. It allows interfacing with the Carlinkit USB adapter and stream audio/video on your computer. The package can be used in the Node.js environment using native USB bindings (libudev-dev
required), or in Chrome (or equivalent browsers) using WebUSB
API.
There are multiple Carplay dongles on the market, the ones that convert wired to wireless carplay WILL NOT WORK. You need one that converts android/factory infotainment systems into Carplay (CPC200-Autokit or CPC200-CCPA etc). The package forwards video feed in h264, and PCM audio coming in from the USB dongle.
There's an included example carplay-web-app
that runs in the browser and renders the Carplay environment. It supports mic input and audio output through Chrome audio stack as well as touch / mouse input.
Acknowledgements
This project is inspired by the work of @electric-monk on the Python version.
Getting Started
Prerequisites
If you are on macOS and want to use the microphone in node
environment, you need sox
brew install sox
If you are on Linux, you need libudev-dev
for USB support in node
environment
sudo apt install -y libudev-dev
Installation
npm install node-carplay
Usage
There is an included example (not in the NPM package, but in the Git repository). It is recommended to take the example and modify your way out of it.
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
The contents of this repository are licensed under the terms of the MIT License.
See the LICENSE
file for more info.