API Examples to get started.

Niels de Klerk Where are you running this SDK program? As far as I know we cant push anything to Neeo Brain yet.  

Paul Benario Cant you just press the remote power button and that turns off all devices running? 

Bhushan Ahire You need a always on device witch is cabaple of Node.JS Version 6 (e.g. A Server, a Raspberry Pi, or else)

in this topic (and the linked ones) you should find anything you need to start using the SDK or code any Drivers for NEEO!

Bhushan Ahire Don't think there is an API command for remote power off button/power off all. 

Paul Benario You can do with the actual API, you just need to call all Recipes and save the State if this recipe is on, you need to switch it of. Or just switch every Recipe OFF when leaving (but there should not be any Stupid devices involved).

Paul Benario Ohh sorry what I meant is not from API, on remote the power button ;) 

Markus Mahr I used and coded my own Sony Bravia SDK on my Mac. Someone commented while back saying you will soon be able to push your custom code to the brain. 

Bhushan Ahire That is at least what NEEO is planning to provide in a later Firmware State. For this you are able to vote over here. In the Meantime, you need an external device and you need to restart the script when the brain is rebooted.

The custom mapping of buttons is also a open idea and therefor you can vote over here.

Bhushan Ahire Yes, that works, but this thread is for the API.. really kills the point if it requires me to press the power button. Upon more testing though, I found that if I do the setpoweroff for the wrong item, it still works. 

So if I setpoweroff for cable, but the appletv was running, it still works successfully, and vice versa.. so I may be set. 

Niels de Klerk I have Kickstarted Product (Remix Mini) which runs on Android. I used that to run SDK application and its working now. 

Niels de Klerk Yes you can. As its linux base. Use Termux terminal and you can use apt to install nodejs with apt install nodejs & git

Niels de Klerk I will see if I can use SDK and make a driver to control Nest 

Bart Meuris yeah... this thread seems to have been here for 6 months and the api was promised from the start.
Any news on when the api docs will be made available?

Bart Meuris Giles Roadnight there is a basic documantation over here:

https://neeoinc.github.io/neeo-sdk/

but due to the fact, that the api is not fully finished, there is currently no other docu beside this topic, and the sdk topic.

Niels de Klerk would be nice if there would be a OpenAPI/Swagger specification (or something similar) for all API's and everything was just built on top of that. That would make things considerably easier/more flexible.

Niels de Klerk the API seems pretty simple yes, but it's still a lot of work to implement complete bindings for other languages.

An OpenAPI/Swagger definition would solve this completely, it's for REST what a WSDL is for SOAP - a full description of the API which can be used to create bindings for many languages and documentation, from one single source.

Once you have the swagger definition file, you'd be able to generate bindings for whatever language, or even get them on-the-fly in dynamic languages by simply loading the swagger file without any code-generation at all.

It's maybe harder to map an existing API to it, but it would be awesome if Neeo would consider using this in the future, maybe for a v2 of the API? Now OpenAPI/Swagger isn't perfect or as flexible as "do whatever you want" - but at least it should be seriously considered for a public REST API.

Niels de Klerk Thanks for the info Niels, this is really helpful, yes I'm referring the actual HTTP protocol for building SDK in different programming languages, will look into your GitHub repo.

Niels de Klerk Thanks for the quick answer :)

I’m testing an apple watch remote for neeo using the API, and I can “get” al the buttons and actions from each recipe.

But under “sonos” recipe there’s some options that I cant get from it

I’m talking about the content inside of  “my sonos” section:

Óscar Abilleira Muñiz i think this info is only displayed at neeo, but it is fetched from sonos. Don't think it is stored anyway outside the Show side of NEEO

Markus Mahr Ok thank’s for the answer ;)

Niels de Klerk That’s will be great 😉

Niels de Klerk Thanks a lot... I will investigate it ;)

Of course when there’s “something usable” I will post here 

Niels de Klerk Yes I know but I can’t find the way to POST this value, ever time returned the same answer

Niels de Klerk For test I use chrome extension “boomerang soap and rest”, but I have also use the one that you posted before, but the same result using “post” with the url.

I was searching into the wiresharks output but nothing seems to be “post” but the url 🙄

Niels de Klerk  Finally I found that I have to post  this, but in all of my test hangs the brain hehe 😂

{"directoryId": “sonos",
"actionUri": “actionUri get from broser url",

"metadata”:”get from browser url”,
"playNow": true,
"playNext": false
}

Óscar Abilleira Muñiz Niels de Klerk  I too am struggling with the POST verb ... from  wireshark I can see that POST is used and I can see what I need to add as arguments. But when I try the statement below (using RESTED) I get "parameter is missing: name"

What am I doing wrong?

POST http://IP_BRAIN:3000/v1/projects/home/rooms/6389247357384392704?details=false {"name": "A/V Devices", "icon": "neeo.icon.room.basement", "key":"6389247357384392704", "weight": 6389247357384393000, "hasController": false, "nrDevices": 3}  

Niels de Klerk that is exactly what I did, make a change through the eui and check wireshark, it included the ?blabla and everything else in my statement (see screenshots).

Leaving the ? out throws me a "not found" message ... also tried replacing , by ; as i remember regional settings on windows machines sometimes gave issues on those but that didn't help either.

Niels de Klerk 

Thanks for the reply :-)

so from a physcial NEEO remote perspective that happens correct, but how does one make use of that with the SDK?

i don’t see any physical buttons in the list.

rather than room/device/key

i was looking for

play 

pause

then my app could simply send the play command (home assistant) and not worry about what is playing as NEEO knows that, and will send the right command

Niels de Klerk right, but i'd need to know what the active recipe is no? i'm asking to push the intelligence to the NEEO brain. 

If you think that is possible, i'll do a little more digging :) right now, just been looking at sending an http request - havent gotten into the smarter stuff yet

Niels de Klerk sorry for my ignorance  :  you mean Official Documentation ? I did not find where. What OP stands for ? 

Niels de Klerk 

Thank you very much for your super fast response.

I tried also with http:

Has anybody a correct Postman setup and could share this?

I also tried file_get_contents or curl, nothing works, only the browser, really strange.

Niels de Klerk 

I cannot find a space 

Niels de Klerk 

I tried also

 $config = Get_Brain_Configuration();
 var_dump($config);

 // Get the brain configuration
 function Get_Brain_Configuration()
 {
    $command = '/v1/projects/home/';
    $config = Send_NEEO_GET($command);
    return $config;
 }

function Send_NEEO_GET($command)
    {
        // IP be found in the about screen of the NEEO app

        $brain_ip = "192.168.55.177";
        $brain_port = 3000;
        $URL = $brain_ip.':'.$brain_port.$command;

        echo $URL."<br>\n";

        $header = ['Content-type:application/json'];
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $URL);
        curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
        curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
        curl_setopt($ch, CURLOPT_TIMEOUT, 30); //timeout after 30 seconds
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

        $result = curl_exec($ch);
        $curl_info = curl_getinfo($ch);
        var_dump($curl_info);
        curl_close($ch);

        return $result;
    }
 

But I get only

192.168.55.177:3000/v1/projects/home/
array(26) {
  ["url"]=>
  string(44) "http://192.168.55.177:3000/v1/projects/home/"
  ["content_type"]=>
  NULL
  ["http_code"]=>
  int(0)
  ["header_size"]=>
  int(0)
  ["request_size"]=>
  int(0)
  ["filetime"]=>
  int(-1)
  ["ssl_verify_result"]=>
  int(0)
  ["redirect_count"]=>
  int(0)
  ["total_time"]=>
  float(20,281)
  ["namelookup_time"]=>
  float(1,0E-6)
  ["connect_time"]=>
  float(0)
  ["pretransfer_time"]=>
  float(0)
  ["size_upload"]=>
  float(0)
  ["size_download"]=>
  float(0)
  ["speed_download"]=>
  float(0)
  ["speed_upload"]=>
  float(0)
  ["download_content_length"]=>
  float(-1)
  ["upload_content_length"]=>
  float(-1)
  ["starttransfer_time"]=>
  float(0)
  ["redirect_time"]=>
  float(0)
  ["redirect_url"]=>
  string(0) ""
  ["primary_ip"]=>
  string(0) ""
  ["certinfo"]=>
  array(0) {
  }
  ["primary_port"]=>
  int(0)
  ["local_ip"]=>
  string(0) ""
  ["local_port"]=>
  int(0)
}
bool(false)

Niels de Klerk 

Thanks for your input again, i checked again firewall and all settings, now it works perfect. Sometimes the problem is sitting in front of the screen.

Chris Shepherd 

Nice - there is alot more you can add to it if you want (like scenarios, device timings, etc).  Take a look at both/either Niels de Klerk homey code or my openHAB code for hints

Tim Roberts Yeah theres plenty missing - I just wanted it out there for feedback. If you have anything in particular you want adding can you create an issue on the repo? Thanks for the feedback bud.

Niels de Klerk 

Thank you, I thought  "Get the brain configuration:" has all info I need, so I make an extra call for every device.

But I haven't found a scenario Key. Is a scenario the same as a recipe, so first  I have to add a recipe?

I am looking for the same