Recently, Yahoo change its API and forcing everyone to use OAuth 1.0 in order to access its data. You may experience empty weather info to Jubito's front-end, as well null responses from relational functions, such %todayconditions%, etc.
I decide to implement the new functionality with openweathermap.org API as the weather data source, which I found it more simple and clear.
3) Paste the URL you get including your APPID as a parameter, i.e.:
http://api.openweathermap.org/data/2.5/forecast/city?id=524901&units=metric&APPID={APIKEY}
You're all set. Now you can use some of the old functions, plus, the new ones for humidity and pressure. Find all the function set in GitHub wiki.
Lately Jubito grows its family by contributions of individuals and vendors and I thank them in public each time I make a reference. More details in social networks e.g.: facebook.
Every piece of hardware I received has an interesting aspect that opens a new challenge to the Jubito ecosystem. For example, Z-Wave integration. An interesting technology, but still, a little bit expensive.
While I'm studying the Z-Way JSON API that allows to execute commands on server side using HTTP GET/POST requests, I'd like to share some early developments for those who want to learn the basics and for the adventurous. In this post I will deal with the RaZberry module by Z-Wave.me on a Banana Pro.
Since I currently owned only one device (Fibaro wall plug) I will focus on SwitchBinary Command Class (0x25/37). The Switch Binary Command Class is used to control all actuators with simple binary (on/off) switching functions, primarily electrical switches.
Those who have experience with the module will probably have a complete understanding of what I'm talking about.
But let's take a look at some methods. The command to execute is taken from the URL. All functions are executed in form: http://YOURIP:8083/<URL>
http://localhost:8083/ZWaveAPI/Run/devices[n].instances[0].SwitchBinary.Set(value) - Binary values accept 0-99 for switching off and 255 for switch on.
http://localhost:8083/ZWaveAPI/Run/devices[n].instances[0].SwitchBinary.data.level.value - Get the state of the device (true->on, false->off).
http://localhost:8083/ZWaveAPI/Run/devices[n].instances[0].Meter.data[s].val.value - Measures the amount of electrical energy in kWh that was consumed.
http://localhost:8083/ZWaveAPI/Run/devices[n].data.givenName.value='<A new name>' - Rename a device [2].
[1] You can include devices by pressing the 'Inclusion' button. This turns the controller into an inclusion mode that allows including a device. A led on the controller indicates this status. The inclusion of a device is typically confirmed with a triple press of a button of this particular device. However, please refer to the manual of this particular device for details how to include them into a Z-Wave network. The inclusion mode will time out after about 20 seconds or is aborted by pressing the 'Inclusion' button again.
The same applies for the 'Exclusion'.
[2] Rename a device:
Use <lock></lock> tags when you want to bypass parser and pass a URI with blank spaces as one argument.
To create an HTTP GET method as an Instruction Set for alternative use, you can move to Instructions->Add New Launcher and put your getter there. This will allow you to invoke a Z-Wave function into another Instruction Set. You can search in this blog for common actions, but I will come back later with analytical article (*).
You can review the whole object in real time to reveal all the available functions but I won't deepen on the data model -yet [ http://localhost:8083/ZWaveAPI/Data ]:
To have a human readable tree view, copy and paste the JSON object to an editor, such www.jsoneditoronline.org.
List of available devices [ http://localhost:8083/ZWaveAPI/Run/devices ]:
Let's stand here and see some examples on Jubito's side.
Jubito has a native API for HTTP GET method i.e.: judo http get <Request-URI>.
Try any of the above operations from the terminal. Examples:
judo http get http://localhost:8083/ZWaveAPI/Run/devices[n].data.givenName.value - Gets device name.
judo http get http://localhost:8083/ZWaveAPI/Run/devices[n].instances[0].commandClass[37].Set(255) - This will switch on the plug. It is equivalent to http://localhost:8083/ZWaveAPI/Run/devices[n].instances[0].SwitchBinary.Set(255) or .Set(0) to switch off.
That was a quick introduction to the Z-Way API. Before you get confused, Jubito comes with a simple interface that implements the basics like, inclusion, exclusion and list of available devices with their actions (on/off), including some additional information.
While is still beta, I won't add a link on the menu button yet, but you can navigate to z-index.html:
http://<host>:<port>/www/z-index.html
Please make sure you have the latest version [0.2.8.299]:
(*) Let's consider this post as the first part of a Z-Wave session. In future articles I will present ways, on how to use a specific function, on a custom Instruction Set, and how these can interact and expand functionality and logic by other mechanisms, including evaluations and schedules.
In order to achieve a fully dynamic front end, I started working on a widget factory. The combination of two different Instruction Sets will give us the ability to view additional real time info within a dashboard item in a bubble form.
I will proceed by doing a simple example using framework functions (%greader% or %gmailreader% and %gcount% or %gmailcount%). The first will return the headers of the message(s) and the other one will be the counter.
Go to Control Panel->Add New Launcher and follow the screenshots...
Now we'll create a new dashboard item that includes both of the above.
Navigate to Control Panel->Add New Instruction Set
Scroll down to Add to Dashboard and fill Category, Header, Thumbnail (optional) and Reference field.
Save it and return to the Dashboard. You should be able to see something like that...
When you click Gmail Check you will get the response of gmail launcher.
For older Instruction Sets, edit the AppConfig.xml and add a reference attribute (ref) that points to the Instruction Set ID you want to call. For this example, gmailwidget.
You may notice temperature and humidity values as well in the screenshots. It has the same logic but first you should take a look at arduino tutorials.
After setting up your gmail account, here's the post to show you how to use the %gmailcount% function to create a gmail notifier.
Go to Control Panel/Mail/Setup/Gmail
Type your username and your password and hit save.
Now we need to make a few scenarios. For instance when emails are more than one then respond with the number of them and so forth. But before we get into that, first we need to create the responses.
Go to Instruction Sets menu, hit Add New Instruction SetAdd New Launcher and follow the screenshots. [ Update: For a more efficient way to create responses please read this post. ]
No new messages.
You have, 1, unread message to your g-mail inbox.
You have, %gmailcount%, unread messages to your g-mail inbox.
Now we have to apply the logic we're talking about in a new Instruction Set.
In the action field copy/paste the following evalBool function...
One of each conditions will be evaluated and trigger the corresponding reply.
Finally we can make a daemon with the Scheduler, to perform checks every 5 minutes. From Scheduler menu hit Add New and type a name, select repeat in the period drop down, time in milliseconds e.g. 300000 for 5 minutes and action the Instruction Set that calls the evalBool function i.e. gmail. To avoid getting 'No new messages' every time, make a new Instruction Set that missing the no-messages evaluation.
Once you wire the module, download the sketch and upload it to arduino.
Alternatively use codebender
Open the serial monitor and approach a token or a card to the antenna. You should receive the tag id.
Now we have readings let's handle them. It's in your discretion what to operate with those, but in this example we will make a simple check-in/check-out sequence.
To achieve our goal we need to evaluate user status in order to switch from present to absent and vice versa when a tag is pointed. At Control Panel click Add New Instruction Set. Type rfideval in the name field (handler) or one of your choice and the evaluation that follows as the action...
'check_me_in' and 'check_me_out' are Instruction Sets that corresponds to our preferred actions. For example, saluting user using %salute% function, announce temperature even turning on a light. Also the %checkin% and %checkout% functions are mandatory to changing the current status.
To see how responses will look or sounds like, go to terminal tab and type... check_me_in; %whereami% check_me_out; %whereami%
...which will execute the commands and after that get the status with %whereami% function.
We can also drive the check-out sequence within an event handler for extra functionality, like a countdown timer that give as time to leave before status is changed. This action can be achieved by pointing the check_me_out Instruction Set to event handler we just describe. The events will look like this...
judo sleep <ms>; %checkout%
The check_me_out Instruction Set now points to check-out-handler.
It would be wise to read about functions and API for extra customization. Also, it would be very handy to know how events work .It will help you to make multiple actions in a single command.
As we may already know, whatever collected by the serial port triggers corresponding events if they exists. This means that if we create a new event handler with name (id) same as RFID tag then it will be triggered when found.
Notice the last id in the serial monitor screenshot. When specific token (with id 6600942812) is acknowledged the event will trigger the evaluator 'rfideval' and change our status accordingly.
In the Internet of Things era, a good practice to communicate between protocol-agnostic software and/or hardware is a tailor made implementation on top of TCP. Jubito is taking advantage of Internet infrastructure and supports communication requests.
UPDATE: Currently the AppConfig.xml configuration file is fully supported by the UI. Under settings you can find menus that corresponds to each functionality.
Trusted clients should be semicolon delimited.
I leave the paragraph below as is, in case you want to edit the file and see things behind the scenes.
Let's move to our example. First of all we need to configure the host and the port. Edit AppConfig.xml file and add your preferences to the following fields...
jaNET/System/Comm/localHost - A hostname of the server to connect to (it can also be its raw IP address) jaNET/System/Comm/localPort - A number representing the TCP port to be used by the socket (Default is 5744) jaNET/System/Comm/Trusted - Authorized clients delimited by semicolon
Sample Screenshot...
Save and close the file and go to Control Panel/Switches and turn on the socket.
Or by terminal...
judo socket open
We'll start our first debugging by sending some data via telnet.
Open command line ot a terminal in linux and type...
telnet <host> <port>
After that, drop some functions and/or commands (Instruction Sets)...
We can even make a RESTful style call from a web browser as well...
Now that we've find how to implement a communication channel and pass through any kind of data, such as built-in functions, judo API calls or custom Instruction Set's, let's see how to utilize it in a hardware manner using an http request by following that article...
...or by making a simple .NET application using the TcpClient Class of System.Net.Sockets namespace illustrated by the method bellow...
private string getServerResponse() { Int32 port = 5744; String host = "localhost"; String msg = "%whereami%\r\n"; // Always terminate command with \r\n else will cause a deadlock and socket need to be restarted.
TcpClient client = newTcpClient(host, port);
// Translate the passed message into ASCII and store it as a Byte array. Byte[] data = System.Text.Encoding.ASCII.GetBytes(msg);
NetworkStream stream = client.GetStream();
// Send the message to the connected TcpServer. stream.Write(data, 0, data.Length);
// Buffer to store the response bytes. data = newByte[16 * 1024];
// Read the first batch of the TcpServer response bytes. Int32 bytes = stream.Read(data, 0, data.Length);
// Close everything. stream.Close(); client.Close();
