https://github.com/waringer/broadlink

Go library for Broadlink RM devices
https://github.com/waringer/broadlink

broadlink broadlink-rm golang golang-library

Last synced: 6 months ago
JSON representation

Go library for Broadlink RM devices

• Host: GitHub
• URL: https://github.com/waringer/broadlink
• Owner: waringer
• License: bsd-3-clause
• Created: 2019-01-06T04:46:38.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-05-19T11:27:26.000Z (about 6 years ago)
• Last Synced: 2024-06-20T06:29:41.506Z (almost 2 years ago)
• Topics: broadlink, broadlink-rm, golang, golang-library
• Language: Go
• Homepage:
• Size: 30.3 KB
• Stars: 3
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Go library for Broadlink RM devices [![pipeline status](https://gitlab.com/waringer/broadlink/badges/master/pipeline.svg)](https://gitlab.com/waringer/broadlink/commits/master) [![Go Report Card](https://goreportcard.com/badge/gitlab.com/waringer/broadlink)](https://goreportcard.com/report/gitlab.com/waringer/broadlink)

This library where created with work from the following pages:

* 

* 

* 

The library is designed to work with Broadlink RM Mini3 or similar devices. It can configure the WLan settings of the device and learn and send IR commands over the device.

**In the root directory is a sample command line program "main.go" where you can see the usage of the library.**

Link to documentation in [![GoDoc](https://godoc.org/gitlab.com/waringer/broadlink/broadlinkrm?status.svg)](https://godoc.org/gitlab.com/waringer/broadlink/broadlinkrm)

## How to's

### * Setup a new device

* Put device in "*AP-Mode*"

* Run "*broadlinkrm.Hello*" to find the device (usually it will have the an IP like 192.168.10.1)

* Run "*broadlinkrm.Join*" to let the device join your Wireless LAN

### * Bring the device in "*AP-Mode*"

* Long press the reset button until the blue LED is blinking quickly.

* Long press again until blue LED is blinking slowly.

* Manually connect to the WiFi SSID named *BroadlinkProv*.

## Function's in the library

### Hello

* In:

```timeout time.Duration```,

```deviceIP net.IP```

* Out:

```chan Device```

* Description:

   Find devices and get info's about it.

### Auth

* In:

```dev *Device```

* Description:

   Authenticate against an device. Updates the security info's of the device struct for further usage.

### Command

* In:

```cmd uint32```,

```data []byte```,

```dev *Device```

* Out:

```[]byte```

* Description:

   Send a command to device.

### Join

* In:

```ssid string```,

```password string```,

```securityMode byte```,

```deviceIP net.IP```

* Out:

```[]byte```

* Description:

   Setup a device in AP-mode to use the specified wlan