abhishekfdd / jeelight

Simple and light Yeelight API

Jeelight

Jeelight is a simple implementation of Yeelight Inter operation specification. The aim of jeelight is to manage for you the discovery and communication with differents Yeelight devices.

Requirement

To use the Lib, you need to have oppened the developer mode in your bulb.

To do this, open your Yeelight mobile application,

• Click in the button that look like an Up Arrow
• Check that the button Control on local network is checked

Dependencies

The Jeelight only depends on log4j2 library.

Discovering devices

The device discovery is based on SSDP protocol. Jeelight provide a simple implementation.

List<Light> devices = new ArrayList<>();
SSDPClient client = new SSDPClient(5000,'wifi_bulb',1982);
client.addListener(new PropertyChangeListener() {
	@Override
	public void propertyChange(PropertyChangeEvent evt) {
		if (SSDPClient.ADD.equals(evt.getPropertyName())) {
			Light l = (Light) evt.getNewValue();
			devices.add(l);					
		}
	}
});
client.startDiscovering();

With this simple code, you start discovering new devices on network and add it in a list.

Communication

Jeelight offers two way to communicate with Yeelight devices. An expert way, where you control each data asynchronously and an easy way where you call methods in a synchronnous way.

The expert way

For the expert way, you need to get a MessageManager.

Then you interact in this way:

Light light = ...
MessageManager manager = MessageManager.getInstance(l);
Future<Boolean> future = manager.send(Method.method, param1, param2,...);
while(!future.isDone()){// Wait}
// Command was executed, can get the result
if(future.get()){
	// Command correctly executed
} else {
	// Command not executed
}

// Or in this way
future = manager.send(Method.method, new Object[]{param1, param2,...});
while(!future.isDone()){// Wait}
// Command was executed, can get the result
if(future.get()){
	// Command correctly executed
} else {
	// Command not executed
}

When an operation modify a parameter of the light, the object is modified when the light send a notification, no need to directly modify object.

The simple way

With the simple way, no need to manage asynchronously your data, everithing is encapsulate in the EasyLight object.

EasyLight eLight = new EasyLight(light);
//Call the method
eLight.toggle();

I most of the cases, the method call return the new value of the modified attribute.

When an operation modify a parameter of the light, the object is modified when the light send a notification, no need to directly modify object.

Listen to light modification

Because Lights are in network, they can be modified by someone else, so you need to listen your lights to be updated with its real state.

Light light = ...;

light.addListener(new PropertyChangeListener() {
	@Override
	public void propertyChange(PropertyChangeEvent evt) {
		if (null != evt) {
			// manage the event.
			// the property name is the modified property annotated in the Light object
			// the old value is the old value (obviously)
			// the new value is the new value
		}
	}
});

Don't forger to remove the listener.

TODO

Actually I need to manage music and scenes methods.

Conclusion

Try it yourself and enjoy