### Build and Run BlinkStick Client (Linux) Source: https://github.com/arvydas/blinkstick-client/blob/master/README.md Instructions for building and running the BlinkStick Client application on Linux using MonoDevelop. It requires installing libusb and MonoDevelop. ```bash sudo add-apt-repository ppa:keks9n/monodevelop-latest && sudo apt-get update && sudo apt-get install monodevelop-latest sudo apt-get install libusb-1.0-0-dev # Clone the repository git clone https://github.com/arvydas/blinkstick-client.git # Open BlinkStick.sln in MonoDevelop 4.0 # Do a _Build -> Build All_ # Then _Run -> Start Debugging_ ``` -------------------------------- ### Build and Run BlinkStick Client (Mac OSX) Source: https://github.com/arvydas/blinkstick-client/blob/master/README.md Instructions for building and running the BlinkStick Client application on Mac OSX using Xamarin Studio. It requires installing Xamarin Studio. ```csharp // Download and install Xamarin Studio 5 // Open BlinkStick.sln in Xamarin Studio // Do a _Build -> Build All_ // Then _Run -> Start Debugging_ ``` -------------------------------- ### Build and Run BlinkStick Client (Windows) Source: https://github.com/arvydas/blinkstick-client/blob/master/README.md Instructions for building and running the BlinkStick Client application on Windows using Xamarin Studio. It requires .NET 4.0 and Gtk#. ```csharp // Open BlinkStick.sln in Xamarin Studio // Do a _Build -> Build All_ // Then _Run -> Start Debugging_ ``` -------------------------------- ### Clone BlinkStick Client Repository (Git) Source: https://github.com/arvydas/blinkstick-client/blob/master/README.md This snippet shows how to clone the BlinkStick Client repository using Git. This is a common first step for building or contributing to the project. ```bash git clone https://github.com/arvydas/blinkstick-client.git ``` -------------------------------- ### BlinkStick.com API Features Source: https://github.com/arvydas/blinkstick-client/wiki/Home Documentation for BlinkStick.com API features, specifically for use with a standalone server. This covers how to leverage the BlinkStick.com API for server-side control of BlinkStick devices. ```APIDOC BlinkStick.com API features for standalone server ``` -------------------------------- ### Standalone Server API Documentation Source: https://github.com/arvydas/blinkstick-client/wiki/BlinkStick.com-API-features-for-standalone-server Documentation for the standalone BlinkStick server API, which runs on port 3000. It details the '/update' endpoint and its parameters for controlling BlinkStick devices, including status, color, patterns, and LED specific overrides. ```APIDOC Standalone Server API: Endpoint: http://127.0.0.1:3000/update Parameters: device (string): The API key of the device to control. If omitted, all devices are updated. status (string): Accepted value is "off" to turn off the BlinkStick. color (string): Color to send to the device as RGB value (rrggbb) or named color. pattern (string): Name of the pattern to play. firstLed (integer): Override index of the first LED to control. Available values are [0..63]. Defaults to the value specified in the notification. lastLed (integer): Override index of the last LED to control. Available values are [0..63]. Defaults to the value specified in the notification. channel (integer): Override channel to control. Applies only to BlinkStick Pro. Available values are [0..2]. Defaults to the value specified in the notification. repeat (string/integer): Number of times to repeat a pattern. Set to "loop" for indefinite looping or a positive integer for a specific number of repetitions. duration (integer): Duration in milliseconds to repeat a pattern. Can only be used with patterns. Cannot be used with 'repeat'. Note: At least one of 'status', 'color', or 'pattern' is required. Examples: Turn BlinkStick off: curl "http://127.0.0.1:3000/update?device=1234&status=off" Set BlinkStick red with default channel and LED index parameters: curl "http://127.0.0.1:3000/update?device=1234&color=ff0000" Set BlinkStick blue and override LED indexes: curl "http://127.0.0.1:3000/update?device=1234&color=0000ff&firstLed=4&lastLed=5" Play pattern "police": curl "http://127.0.0.1:3000/update?device=1234&pattern=police" Play pattern "police" on all connected BlinkSticks: curl "http://127.0.0.1:3000/update?pattern=police" Play pattern "police" 5 times: curl "http://127.0.0.1:3000/update?device=1234&pattern=police&repeat=5" Play pattern "police" and keep playing until a color is sent or another pattern playback is requested: curl "http://127.0.0.1:3000/update?device=1234&pattern=police&repeat=loop" Play pattern "police" for LEDs 1..5: curl "http://127.0.0.1:3000/update?device=1234&pattern=police&firstLed=1&lastLed=5" Play pattern "police" for 5 seconds with default settings: curl "http://127.0.0.1:3000/update?device=1234&pattern=police&duration=5000" ``` -------------------------------- ### Configure BlinkStick Client with Standalone Server Source: https://github.com/arvydas/blinkstick-client/wiki/BlinkStick.com-API-features-for-standalone-server This snippet shows how to configure the BlinkStick Client application to connect to a local standalone server by modifying the data.json file. It specifies the ApiAccessAddress to point to the local server. ```json { "ApiAccessAddress": "http://localhost:3000/faye" } ``` -------------------------------- ### Remote Control API Source: https://github.com/arvydas/blinkstick-client/wiki/Home Documentation for the Remote Control API of the BlinkStick Client application. This API allows external control of BlinkStick devices through the client application. ```APIDOC Remote Control API for client application ``` -------------------------------- ### Test Connectivity to BlinkStick Client API Source: https://github.com/arvydas/blinkstick-client/wiki/Remote-Control-API-for-client-application Tests the status of the BlinkStick Client API. It requires no parameters and returns the client's name, version, and full version. ```APIDOC Test Connectivity: GET http://127.0.0.1:9000/api/v1/test Parameters: None. Response JSON: {"name":"BlinkStick Client","version":"2.0-RC6","versionFull":"2.0.5899.24666"} ``` -------------------------------- ### Play Pattern on BlinkStick Device Source: https://github.com/arvydas/blinkstick-client/wiki/Remote-Control-API-for-client-application Plays a specified pattern on a BlinkStick device. Requires the device's serial number and the pattern name. Allows specifying LED range and channel. Defaults to the first LED. ```APIDOC Play Pattern: GET http://127.0.0.1:9000/api/v1/play_pattern/[BlinkStick-Serial-Number] Parameters: - [BlinkStick-Serial-Number] (Required): The serial number of the BlinkStick device. - pattern (Required): The name of the pattern to play. Must exist in the client application's patterns. - firstLed (Optional): Index of the first LED to control (0-63). Defaults to 0. - lastLed (Optional): Index of the last LED to control (0-63). Defaults to 0. - channel (Optional): Channel to control, applicable for BlinkStick Pro (0-2). Defaults to 0. Examples: Play pattern "police" on the first LED: curl "http://127.0.0.1:9000/api/v1/play_pattern/BS123456-7.8?pattern=police" Play pattern "police" on LEDs with index 4 to 7: curl "http://127.0.0.1:9000/api/v1/play_pattern/BS123456-7.8?color=0000ff&firstLed=4&lastLed=7" ``` -------------------------------- ### Set Color on BlinkStick Device Source: https://github.com/arvydas/blinkstick-client/wiki/Remote-Control-API-for-client-application Sets the color of LEDs on a BlinkStick device. Requires the device's serial number and allows specifying color, LED range, and channel. Defaults to black color and the first LED. ```APIDOC Set Color: GET http://127.0.0.1:9000/api/v1/set_color/[BlinkStick-Serial-Number] Parameters: - [BlinkStick-Serial-Number] (Required): The serial number of the BlinkStick device. - color (Optional): The color of the LEDs. Can be a named color (e.g., red) or a hex code (e.g., ff0000). Defaults to 'black'. - firstLed (Optional): Index of the first LED to control (0-63). Defaults to 0. - lastLed (Optional): Index of the last LED to control (0-63). Defaults to 0. - channel (Optional): Channel to control, applicable for BlinkStick Pro (0-2). Defaults to 0. Examples: Set blue first LED: curl "http://127.0.0.1:9000/api/v1/set_color/BS123456-7.8?color=0000ff" Set red color to LEDs from index 4 to 7: curl "http://127.0.0.1:9000/api/v1/set_color/BS123456-7.8?color=0000ff&firstLed=4&lastLed=7" Set all LEDs green from 0 to 63 on channel 1: curl "http://127.0.0.1:9000/api/v1/set_color/BS123456-7.8?color=0000ff&firstLed=0&lastLed=63&channel=1" ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.