As I am working quite a lot on this driver nowadays, don't hesitate to supporte me to buy coffee. More coffees help me getting awake longer time and being more productive :-).
You can join the community here: https://discord.gg/3nuUZwXVXA And here (backup): https://t.me/joinchat/NocMDU9RCVP9hSCJxPsCEg
Programmable driver for NEEO to control any device and generate complex integration. Examples of integration:
/!\ The meta is now in V1.0 Beta and can be freely and secured downloaded /!\
More than a driver, the meta is an extension platform for the neeo remote and is now fully packaged with the meta Installer from Ton O and using preliminary work from Dennis and Niels to root the brain. The platform as build provides the following key features:
- capacity to run custom drivers directly in the brain (drivers are softwares adding support of new devices for the neeo)
- development platform allowing fast creation of complex Neeo drivers
- capacity to install/uninstall drivers directly from your remote
- built-in super rich interoperability platform to allow easy connection to any of your devices (TV, Avr, media player, lights, ...)
- Full intefrstion with HA, node-red, home assistant through MQTT.
- meta is bundled natively with Mqtt broker and node-red in order to allow easy new drivers creation relying on node-red rich integration library.
Upcoming v1.0.8 #Creator Edition
- Vastly improved discovery with mDNS technology allowing to detect softwares as well as hardware (Kodi, Spotify, Chromecast, ...)
- Improved multibrain management
- Largely improved log for better debugging when creating new driver (part 1)
- Braon installer Install Python3! (Great to enable some complex drivers like broadlink) If time allows:
- improved log part 2
- Imitial Kodi driver? (To he confirmed by Ton)
- Imitial Broadlimk support
Current version is v1.0.7
- Full Discovery feature allowing to automatically discover the IP of your devices.
- Enhanced support for HTTP-REST (incl. PUT)
- Extended jsonpath support (new framework and multithreaded execution)
- Fully working registration support for security code.
- Sample registration devices: snapcast, Philips hue with color pick, yamaha network receiver with model detection.
- Refined polling activation for device listening.
- Refined resource management for discovered devices.
- none so far.
Version 0.8.1 brings some bug fixes as well as:
- Architecture refactoring with creation of a Variable Vault (centralized)
- Creation of a datastore to persist value on the device drive (step 1)
- MQTT support
- Devices Discovery fully spported
- Devices registration (step 1, only code)
- Enhance polling activation for device listening.
Version 0.7.3 brings some minor bug fixes as well as:
- By default Brain Navigator device
- minor bug correction
- Devices discovery (for Hub devices like Philips Hue or Snapcast)
- Refined device listening with better Brain resource management.
- Improved Volumio sample device
- Snapcast support (in progress)
- Technical protocol: JSON over TCP
95% of NEEO Interface is fully supported so far:
- Create Buttons
- Create sliders
- Create Brightness sliders
- Create switches
- Create Images
- Create lists (directories) with paging and complex navigation (items and tiles) ==> to be supported: buttons inside directories (don't have a use for this yet), Sonos style player (bug on the cover display).
- Buttons, sliders, switches, directories triggers any action you want.
- Link buttons with sliders (volume increase will move the volume slider for example).
- Have your switches, sliders, labels display the value of your variables.
- Chained commands (one button has different behaviour each time pressed. Example: mute toggle will mute on or off when pressed)
- Variables Management for complex integrations => a button or a choice in a list, can write in a variable, this variable can be reused by other components.
- Listen to devices through Socket or HTTP pooling ==> Neeo Remotes components change following devices change (for example if you increase manually the volume of your receiver, the volume will change accordingly). Or when you play a song, the slider will show the progress of the song.
- Control any device with HTTP-GET, POST, PUT and JSON API (REST).
- Control any device with Socket.IO/WebSocket and JSON API.
- Control any device with HTTP-GET and XML API.
- Control any device with Json over TCP.
- Control any device with CLI.
- Control any device with MQTT.
- Wake On Lan
- all meta drivers graphical components are available through mqtt allowing to control the neeo through HA, Homey or HomeAssistant.
- Device Discovery (examples for Philips Hue bulbs and groups, Snapcast driver)
- Basic registration with security code. (example for Philips Hue and Yamaha Network Receiver)
This driver is based on Node.js technology, therefore you need to install node.js first on your computer: https://nodejs.org/en/download/. At time of writing this article (Q3 - 2020) this driver support the latest version of node.js. Note: this driver can be directly installed on the Neeo brain provided that you root it first. Please consult the following repository to get more information: https://github.com/jac459/NeeoDriversInBrain. Note that installing the driver in the brain is more complex overall and it is recommended to start by using a computer or a raspberry ideally.
In order to install, look at the right of your screen to see the release section and click on TAG. Then choose the latest release (currently alpha 1).
Download the zip of the repository and unzip/unrar in your target computer (or brain).
Go to the created folder and type:
npm install
This command will install the driver and all the dependencies. You need to have an internet access in order to download the dependencies.
Alternatively you can also type:
npm install jac459/metadriver
This will install the latest version of the driver in a folder named node_modules/@jac459/metadriver.
The main dependency you are installing is obviously the ÑEEO libraries. They are automatically installed so you don't need to go to NEEO's github. Other than that you install a hand full of connection libraries in order to connect to the various potential devices you own and speaking all slightly different languages.
To run the driver, you can either type:
npm start
or
node meta
This driver is a Meta driver. That means that in fact it is not really a driver but an engine in order to create dynamically drivers. It dynamically uses JSON setting files (device files) in order to create various drivers loaded in the Neeo brain. A few examples of drivers are provided in 'activated' and 'deactivated' folders. Any file put in the 'activated' folder will be interpreted in order to generate a new driver. One advantage of this approach is that resources are well centralized and are supposed to have lesser impact on the brain. Also, if you run from a Raspberry, the max number I have been able to load is 8 devices. Using this driver you can load as many drivers as you need. Another advantage is that there is only one code base running all the drivers so it will be theoretically easier to track bugs. Simple drivers will have very simple device files but expect a bit more complexity for advanced interactions.
The target for this driver is to create a "device files database" in order to continue to support many new devices when the Neeo cloud will close.
In terms of architecture, this driver is based on 4 main parts:
Constitutes the glue with NEEO API to create the graphical side (kind of MVC).
The main engine including a basic syntax engine interpreting the device.json file in order to create the desired behaviors.
The glue to the outside world. Depending of the device maker's choice, it will trigger different techniques in order to interact with the actual device to be controlled. It contains both the communication protocols and the data retrieval strategy (xpath, jsonpath, regex). It is a kind of strategy pattern.
This vault contains all the data manipulated by the devices created, as well as the callback to be called when a value is changed (kind of observer pattern). It also contains the persistency logic.
When you start the driver, the driver will scan your "activated" folder and try to load any device placed there.
IMPORTANT: On the first run, the driver will detect your Neeo Brain and create a 'config.js' file in order to store its IP and Port. If you have problems connecting, make sure to delete the "config.js" file and run again. If you still can't connect and the port is taken, you can manually edit the config.js file and change the port number (any arbitrary number).
If the driver is correctly loaded, you can go to your Neeo App and search for the name of the driver you created.
To use the driver without creating your own device files, you just need to know that and put the device files you are interested in to the "activated" folder and restart the driver. You will now be able to run them on the remote.
As of today, the majority of devices created are based on AV Receiver type of device as it is the most versatile. This device doesn't appear by default in the remote interface and you need to go to the recipe part in the app/GUI in order to make it visible. Also, you will probably need to add your own shortcuts in order to compose the interface you like the way you want. When running the device through the remote it will bring you to the shortcut slide. You can generally remove other slides as not useful.
Some devices store data. For example, if you have a device needing a registration code, the meta will save the code in -datastore.json file in order to avoid the need to type it again. If somehow the installation of your device doesn't work and the device doesn't behave the way you want, you may prefere to dete the -datastore file and restart the meta in order to have a fresh install of your driver.
Some drivers are "observing" the devices to reflect the state they are in, even if not changed by the remote (ex: volumio, hue). In order to start the listening process,you must launch "power on" when you start the recipe of the device. If it is for lights,you need to do it for each lights (power on will not switch them on but activate the listening). Don't worry,the meta is automatically optimizing the requests in order to minimize the network load (only one request for multiple devices when possible)
TODO: add how-to for the different devices created
Hey, if you plan to create your own device for the metadriver, you are very much welcome and encouraged to do so. You can go to the folling link in order to find plenty of information on it.
https://github.com/jac459/metadriver/blob/master/TUTORIALS.md
You can also use the more up-to-date explanation of the yamaha driver: https://github.com/jac459/metadriver/blob/master/YAMAHARECEIVER-EXPLAINED.md More full explanation for other devices will be created in the future.