LOGIN  |  REGISTER
Smart Living Made Brilliant!
CASTLEOS FORUM

HomeCastleOS API

Information, FAQs, Q&As, and everything else related to the CastleOS API can be found here

API Messages in this topic - RSS

Phil Hawthorne
Phil Hawthorne
Posts: 400


4/2/2015
Phil Hawthorne
Phil Hawthorne
Posts: 400
I'm looking forward to getting on board the CastleOS, and losing my bank balance to the home automation addiction.

As a web developer, I work a lot with REST API's, which run over HTTP.

I would really like to be able to extend the features of CastleOS with a REST API if possible. I haven't downloaded CastleOS yet to play with, but ideally I'd like to know:

1. Can CastleOS call external HTTP API's, or be taught how to? I'll take a look at the scripting tools available, but I've never created something in C. Some ideas that could be used include the "fluffy" ones like "post a tweet" or read Facebook status. But with HTTP API's there's a lot that can be done.
2. Can CastleOS be manipulated by a HTTP API? For example. a local webserver calling CastleOS via HTTP to turn on lights or the TV?

The only slight mention I found was in a previous topic, but it hasn't had much activity: http://www.castleos.com/forum/topic13-open-api.aspx
0 link
Chris Cicchitelli
Chris Cicchitelli
Administrator
Posts: 3390


4/7/2015
Chris Cicchitelli
Chris Cicchitelli
Administrator
Posts: 3390
Phil Hawthorne wrote:
I'm looking forward to getting on board the CastleOS, and losing my bank balance to the home automation addiction.

As a web developer, I work a lot with REST API's, which run over HTTP.

I would really like to be able to extend the features of CastleOS with a REST API if possible. I haven't downloaded CastleOS yet to play with, but ideally I'd like to know:

1. Can CastleOS call external HTTP API's, or be taught how to? I'll take a look at the scripting tools available, but I've never created something in C. Some ideas that could be used include the "fluffy" ones like "post a tweet" or read Facebook status. But with HTTP API's there's a lot that can be done.
2. Can CastleOS be manipulated by a HTTP API? For example. a local webserver calling CastleOS via HTTP to turn on lights or the TV?

The only slight mention I found was in a previous topic, but it hasn't had much activity: http://www.castleos.com/forum/topic13-open-api.aspx



Hey Phil! CastleOS has a built in WCF and REST API. It's discoverable and annotated. A lot of people have requested the ability to create virtual devices that make HTTP calls, and that is actively in the works now for the next API release.

There's more detail on the feature pages about the upcoming changes to the API. The current API supports interacting with the Core Service - in fact all of our own UIs use the API, so it's all that is needed to build a full GUI or do anything else. The changes that will be coming with CastleOS 2.0 and the CastleHUB will allow for the creation of virtual devices and protocols. This will allow any HTTP call to be made outbound, or received inbound.

Thanks!!
0 link
Tommy Long
Tommy Long
Posts: 218


4/7/2015
Tommy Long
Tommy Long
Posts: 218
Hi Chris, How does one discover the APIs? For example, with some of the Kinect scripts I've written, I'd like to be able to tell the remote core service to turn a light off.
0 link
Phil Hawthorne
Phil Hawthorne
Posts: 400


4/9/2015
Phil Hawthorne
Phil Hawthorne
Posts: 400
Chris Cicchitelli wrote:

Hey Phil! CastleOS has a built in WCF and REST API. It's discoverable and annotated.

So is this available in CastleOS v1.2.1375? I can't see any mention of it inside the software, the how-to guides or a Google search (which this thread is the top result for). How does one discover these discoverable APIs?1.2.1375

Chris Cicchitelli wrote:
There's more detail on the feature pages about the upcoming changes to the API. The current API supports interacting with the Core Service - in fact all of our own UIs use the API, so it's all that is needed to build a full GUI or do anything else.

Are you referring to this page, mentioning an update due in February? http://castleos.com/FeatureSpotlight.aspx?feature=CustomScripting

Chris Cicchitelli wrote:
The changes that will be coming with CastleOS 2.0 and the CastleHUB will allow for the creation of virtual devices and protocols. This will allow any HTTP call to be made outbound, or received inbound.

Do you have any screenshots of this new CastleOS that will ship with the CastleHub? With shipments of CastleHub due in about 8 weeks time, you must be on the tail-end of this new version, so should have something you can show us. It would be nice to know this new version actually exists.
0 link
MrMxyzptlk
MrMxyzptlk
Posts: 18


4/9/2015
MrMxyzptlk
MrMxyzptlk
Posts: 18
Pushy, Pushy. I hear where you are going with this Phil. I too am very skeptical on the timeline, especially when you look at past threads and missing promised dates continually. I'm taking a calculated risk by backing the hub and running the software, as I feel that Microsoft probably has some skin in the game on this project...I guess only time will tell.
0 link
Chris Cicchitelli
Chris Cicchitelli
Administrator
Posts: 3390


4/9/2015
Chris Cicchitelli
Chris Cicchitelli
Administrator
Posts: 3390
Hey Phil, the WCF API has been there since the beginning, the REST API was added a few months ago to support our Android App development. Both are available in the version you have downloaded. To discover the services, you can use any web service explorer and point it to CastleOS on your machine: http://localhost/CastleOS/service?wsdl You can also put that address in your web browser to see the raw XML if you'd like.

The Custom Scripting as an Action is in testing now, and will be in the next release. We do currently have the Custom Scripting as a voice command.

We post a history of our update progress on the forum here: http://www.castleos.com/forum/topic168-castleos-core-service-changelog.aspx

The cumulation of the Release Candidates is the version 2.0 release. Next up, in addition to the custom scripting as an action, is support for the TCP Connected protocol, among others. We'll be continually updating the software as we work towards the CastleHUB release this summer.

-Chris
0 link
Phil Hawthorne
Phil Hawthorne
Posts: 400


4/9/2015
Phil Hawthorne
Phil Hawthorne
Posts: 400
Chris Cicchitelli wrote:
Hey Phil, the WCF API has been there since the beginning, the REST API was added a few months ago to support our Android App development. Both are available in the version you have downloaded. To discover the services, you can use any web service explorer and point it to CastleOS on your machine: http://localhost/CastleOS/service?wsdl You can also put that address in your web browser to see the raw XML if you'd like.

Perfect thanks! I'll give that a go. Is there a /help endpoint or anything I can use to see the annotations?

Chris Cicchitelli wrote:
The Custom Scripting as an Action is in testing now, and will be in the next release. We do currently have the Custom Scripting as a voice command.

There seems to be a lot of "crossover" between the Core service, and voice addons. I'll add another thread about this, as it does need to be cleaned up IMO.

Chris Cicchitelli wrote:
The cumulation of the Release Candidates is the version 2.0 release. Next up, in addition to the custom scripting as an action, is support for the TCP Connected protocol, among others. We'll be continually updating the software as we work towards the CastleHUB release this summer.

Awesome. A bit nit picky, but in a lifecycle, wouldn't the features that were going to be in 2.0 be finalized, before getting to a "release candidate" stage? Sounds like the software is still in development, and the "release candidates" you're releasing are bleeding edge feature builds.

MrMxyzptlk wrote:
Pushy, Pushy. I hear where you are going with this Phil. I too am very skeptical on the timeline, especially when you look at past threads and missing promised dates continually. I'm taking a calculated risk by backing the hub and running the software, as I feel that Microsoft probably has some skin in the game on this project...I guess only time will tell.

Sorry - I don't mean to be rude. I'm really excited about this product, and I want to help out as best I can. Programming and automation has always been a big passion of mine, so if I can help out in any way possible for the right product I will. However the past threads on the forum don't exactly give you anything to write home about just yet. But I think this product has a lot of potential, and I'm very excited for it.
+1 link
Michael Wallace
Michael Wallace
Posts: 52


9/26/2015
Michael Wallace
Michael Wallace
Posts: 52
Chris, when with the 2.0 API be released?
0 link
Chris Cicchitelli
Chris Cicchitelli
Administrator
Posts: 3390


9/29/2015
Chris Cicchitelli
Chris Cicchitelli
Administrator
Posts: 3390
Michael Wallace wrote:
Chris, when with the 2.0 API be released?



October
0 link
Michael Wallace
Michael Wallace
Posts: 52


10/23/2015
Michael Wallace
Michael Wallace
Posts: 52
Any update on this Chris? Halloween fast approaches.
0 link
Chris Cicchitelli
Chris Cicchitelli
Administrator
Posts: 3390


10/23/2015
Chris Cicchitelli
Chris Cicchitelli
Administrator
Posts: 3390
Michael Wallace wrote:
Any update on this Chris? Halloween fast approaches.



We're getting reallll close to release... The CastleHUB/CastleOS will auto update when it's released..
0 link
Michael Wallace
Michael Wallace
Posts: 52


10/31/2015
Michael Wallace
Michael Wallace
Posts: 52
Chris, I see the new version is out. Is there a how-to on the new API? Is it a straight REST API? Is this still the location for every command http://localhost/CastleOS/service?wsdl ? My Hub also does not seem to have had its license activated yet. Can you help me out with that? Thanks again.
0 link
Gary Bixler
Gary Bixler
Posts: 11


10/31/2015
Gary Bixler
Gary Bixler
Posts: 11
Hi,
I also noticed the new release although not version 2. I couldn't find any references to http requests as event triggers or anywhere else. Does that mean it will be forthcoming?
Thanks Gary
0 link
Chris Cicchitelli
Chris Cicchitelli
Administrator
Posts: 3390


11/1/2015
Chris Cicchitelli
Chris Cicchitelli
Administrator
Posts: 3390
Hey guys, it's partially implemented in this release. Give us another two weeks for the full API update. I'd recommend holding off on integration attempts until then because things will be changing in the API...

Thanks!!
0 link
wolfpaw
wolfpaw
Posts: 59


11/9/2015
wolfpaw
wolfpaw
Posts: 59
Mmmm.


Can we have it now? I would sent me dirty socks for the holoween prank, I really want to play with the z wave stuff. Just got a sledge door lock that works off of z wave, and seems like COS isn't want to lock it or unlock the thing.


Blind Wolf


Gary Bixler wrote:
Hi,
I also noticed the new release although not version 2. I couldn't find any references to http requests as event triggers or anywhere else. Does that mean it will be forthcoming?
Thanks Gary
0 link
Michael Wallace
Michael Wallace
Posts: 52


11/24/2015
Michael Wallace
Michael Wallace
Posts: 52
Any update Chris? It's been 4 weeks now.
0 link
wolfpaw
wolfpaw
Posts: 59


12/6/2015
wolfpaw
wolfpaw
Posts: 59
So is the new update out yet?


Thanks


Blind Wolf
0 link
Michael Wallace
Michael Wallace
Posts: 52


12/8/2015
Michael Wallace
Michael Wallace
Posts: 52
^ What he said
0 link
Phil Hawthorne
Phil Hawthorne
Posts: 400


12/8/2015
Phil Hawthorne
Phil Hawthorne
Posts: 400
^ What they said

6 weeks and counting. More if you remember is was promised in July...September...October...November...now December. Maybe we'll see it in February or March, 12 months after the Hubs Kickstarter.
0 link
Mbassham
Mbassham
Posts: 59


12/10/2015
Mbassham
Mbassham
Posts: 59
Ditto.

What I don't get is that surely Chris understands that potential customers might just peruse the forum before buying. His present customers are clearly frustrated with the lack of bug fixes and communication about when updates will be released. Chris' responses to forum posts, emails or direct messages (I've tried all 3) are sporadic at best. This does not seem to be a good way to build this business. Now that I've purchased a Hub, I have somewhat of a vested interest in the success of CastleOS as I want the software to continue to be supported and improved. But, perhaps I should just give up now.
0 link