soundtouch (community library)

Summary

Name	Value
Name	soundtouch
Version	0.1.3
Installs	385
License	MIT
Author	mattbornski
Repository	https://github.com/mattbornski/Particle-Soundtouch-Control.git
Download	.tar.gz
All Versions	0.1.3, 0.1.2, 0.1.1, 0.1.0

Bose Soundtouch discovery and control on local network

Example Build Testing

Device OS Version:

This table is generated from an automated build. Success only indicates that the code compiled successfully.

Library Read Me

This content is provided by the library maintainer and has not been validated or approved.

soundtouch

A Particle library for basic control of Bose Soundtouch speakers.

Usage

Have a Soundtouch speaker on your network
Have a Particle device on your network
Run a project using this library on your Particle device
Observe that this library discovers your Soundtouch speaker
Observe thsat this library doesn't do much useful to control it yet
Send a pull request implementing the thing you want to do

See the examples folder for more details.

Documentation

The major API is the Speaker class. Currently the best way to obtain a Speaker class is to either use the Soundtouch class to discover one, or to instantiate directly with an IP address.

Contributing

Here's how you can make changes to this library and eventually contribute those changes back.

To get started, clone the library from GitHub to your local machine.

Change the name of the library in library.properties to something different. You can add your name at then end.

Modify the sources in and with the new behavior.

To compile an example, use particle compile examples/usage command in Particle CLI or use our Desktop IDE.

After your changes are done you can upload them with particle library upload or Upload command in the IDE. This will create a private (only visible by you) library that you can use in other projects. Do particle library add soundtouch_myname to add the library to a project on your machine or add the soundtouch_myname library to a project on the Web IDE or Desktop IDE.

At this point, you can create a GitHub pull request with your changes to the original library.

If you wish to make your library public, use particle library publish or Publish command.

LICENSE

Licensed under the MIT license