https://github.com/nitram509/blil-web

https://github.com/nitram509/blil-web

blink1 blinkstick blinky web

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/nitram509/blil-web
• Owner: nitram509
• License: mit
• Created: 2020-05-19T15:23:22.000Z (over 4 years ago)
• Default Branch: blil-web
• Last Pushed: 2023-11-06T04:14:25.000Z (about 1 year ago)
• Last Synced: 2024-06-20T23:55:23.760Z (7 months ago)
• Topics: blink1, blinkstick, blinky, web
• Language: Go
• Size: 20.5 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# BliL-Web - Blinking Light Web

A web server/application, which makes a Blinkstick and compatible devices available via REST API (HTTP + JSON)

Written in GO, works on Windows and Mac OS X

#### License

The MIT License (MIT)

## How to run the server

Once the Go code is compile, the blil-web executable offers some command line options.

```shell script

>>> ./blil-web --help

usage: blil-web []

Flags:

  --help           Show help.

  -p, --port=8080  listen on port

  -i, --interface="127.0.0.1"  

                   listen on interface

  --version        Show application version.

```

## How to use the API

### get all available devices

GET http://localhost:8080/

```json

{

    "version": "0.0.1",

    "name": "BliL - Blinking Light",

    "_embedded": {

        "leds": [

            {

                "number": 0,

                "type": "BlinkStick",

                "path": "USB_20a0_41e5_14100000",

                "_links": [

                    {

                        "self": {

                            "href": "http://localhost:8080/led/0",

                            "title": "Set or get color on this LED"

                        }

                    }

                ]

            }

        ]

    }

}

```

### set a color

POST http://localhost:8080/led/0/green

```json

{

    "number": 0,

    "color": "008000"

}

```

## Known issues

* there is no authentication/security implemented

## Supported devices

* [blink(1)](http://blink1.thingm.com/)

* [LinkM / BlinkM](http://thingm.com/products/linkm/)

* [BlinkStick](http://www.blinkstick.com/)

* [Blync](http://www.blynclight.com/)

* [Busylight UC](http://www.busylight.com/busylight-uc.html)

* [Busylight Lync](http://www.busylight.com/busylight-lync.html)

* [DreamCheeky USBMailNotifier](http://www.dreamcheeky.com/webmail-notifier)

_powered by_ https://github.com/boombuler/led