https://github.com/panicpanicpanic/filament

An unofficial library for the LIFX HTTP API written in Go 💡
https://github.com/panicpanicpanic/filament

golang iot lifx

Last synced: 6 months ago
JSON representation

An unofficial library for the LIFX HTTP API written in Go 💡

• Host: GitHub
• URL: https://github.com/panicpanicpanic/filament
• Owner: panicpanicpanic
• License: mit
• Created: 2018-10-21T03:55:07.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-12-27T04:58:11.000Z (over 1 year ago)
• Last Synced: 2024-12-27T05:25:06.103Z (over 1 year ago)
• Topics: golang, iot, lifx
• Language: Go
• Homepage: https://www.lifx.com
• Size: 38.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Filament [![Go Report Card](https://goreportcard.com/badge/github.com/panicpanicpanic/filament)](https://goreportcard.com/report/github.com/panicpanicpanic/filament)



  



Filament is an unofficial Go wrapper for [LIFX's HTTP API](https://api.developer.lifx.com/docs).

## Build Status

| branch | status |

| --- | --- |

| `develop` | [![CircleCI](https://circleci.com/gh/panicpanicpanic/filament/tree/develop.svg?style=svg)](https://circleci.com/gh/panicpanicpanic/filament) |

| `master` | [![CircleCI](https://circleci.com/gh/panicpanicpanic/filament/tree/master.svg?style=svg)](https://circleci.com/gh/panicpanicpanic/filament) |

## Installation

```sh

$ go get github.com/panicpanicpanic/filament

```

## How To Use

### Authentication

In order to access your LIFX devices, you must first have a valid access token. You can visit the [LIFX Cloud page](https://cloud.lifx.com/settings) to set one up:

![](https://files.readme.io/Uw1PRNPoQ7nFUYDuT6oA_GetLIFXToken.gif)

### Using your LIFX Access Token in Filament

Once you have an access token, you use Filament like this:

```

import(

    "github.com/panicpanicpanic/filament"

    "github.com/panicpanicpanic/filament/lifx"

)

client := lifx.Client{

        AccessToken: "someRandomToken"

    }

_, err := filament.SomeMethod(&client)

if err != nil {

    fmt.Println("handle your error")

}

```

# Available Methods

All methods are available in this [godoc](https://godoc.org/github.com/panicpanicpanic/filament)!

## Contributing

Want to contribute? Just fork the repo, make a feature/bug PR and send it over! Just make sure your tests are passing :)

License

----

MIT

**I'm not affiliated with LIFX, but they are fucking awesome, so you should buy their 💡!**