GithubHelp home page GithubHelp logo

ajipsum / cast-web-api Goto Github PK

View Code? Open in Web Editor NEW

This project forked from vervallsweg/cast-web-api

0.0 1.0 0.0 385 KB

Quick and dirty web API for Google Cast enabled devices.

License: GNU General Public License v3.0

Dockerfile 0.17% JavaScript 89.01% HTML 10.83%

cast-web-api's Introduction

cast-web-api

npm version Dependency Status npm

Web API for Google Cast enabled devices, based on the node-castv2 implementation by thibauts.

This API is only intended to be used on your local network not for hosting on the public internet.

Installation

You probably don't want to install the api directly. For a GUI install cast-web-api-desktop, for headless server installation use cast-web-api-cli.

Usage

Basics

cast-web-api tries to behave like the Google Home app. All available devices will be connected to, if a device goes down, it'll be removed. If it randomly disconnects, it'll try to reconnect. The autoConnect behavior can be turned of with the config parameter autoConnect. This can be helpful for large speaker groups.

Parameters

Every changed parameter will be saved in /config/config.json. This location will be changed in the next release.

Documentation

Online

Parse the swagger.json, in the online editor.

Local

Install the devDependencies for instance git clone this repo then npm install into the repo. Docs now available at /swagger.

Debugging //TODO: remove/edit

Every log output follows this format: {time} {device id} {function name}: {message}. For easy differentiation between those components, device id is inverted in color and function name underlined. Info messages appear in your standard terminal color. Error messages in red, warning messages in red and server related messages in blue.

2018-03-31T18:27:09.508Z a90824f40764eb5df1fccc4f5cb95dd3 reconnectionManagement(): reconnecting

By default only certain messages are logged, to enable all log-levels see the swagger documentation on /config.

Further information

thibauts wrote a great protocol description. I can only highly recommend reading it.

If you read the first sentences of this file it goes without saying that you should not run this API on the internet. Run it behind a firewall only in your local network!

If you find a bug or typo, feel free to contact me, open an issue, fork it, open prs, you name it.

cast-web-api's People

Contributors

c99koder avatar kevireilly avatar naresaservice avatar sphr2k avatar vervallsweg avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.