Howto start with JavaScript API

[johannes]

Hello!
Last few days I started to dive into the JavaScript API of Z-Way and I want to start an own home automation project with serverside programming.
But I do not really got it, how to set up the project and the whole toolchain on my raspberry.

What I had done until now:
- installed node.js and npm
- installed express framework -> but do I really need this? I set up an express project that runs a webserver, but what libraries do I need to import and where do I get them? Do I have to copy them from automation/modules or can I point on them anyhow? How do I go ahead from here?
- the README.md inside the automation folder says I should test with gulp -> do I need Gulp?

I think I'm a little bit confused about all the things and how they come together. Can anyone give me a kind of red line or point me to a tutorial that gives me a clear overview about these things?

Greez a lot!
Johannes

[pz1]

Documentation: http://razberry.z-wave.me

[johannes]

Hi,
I know this website and I studied almost everything but I think it focusses on programming with the HTTP-Interface for client side.
I cannot find code samples for server side Virtual Device API.
I want to do some server-side programming with the Java Script API as referenced in the in zwayDev.pdf in Chapter 1.3.4 and Chapter 5.
But I can only find samples like

Code: Select all

dev = this.controller.devices.get('ZWayVDev 6:0:37');
dev.command('o');

The code samples section (http://razberry.z-wave.me/index.php?id=15) only offers sample code for HTTP API's.

Greez a lot!
Johannes

[gsaw]

Hi,

it depends of what you mean under server side programming. ZWay is already a working system with web server, infrastucture and so on. Why should you need an another web server, node. io and so on?

Better look at existing modules under automation/modules. Thre is readable source code. Just copy modules's folder and play with it.

[johannes]

Hi,
I wanted to implement my own "individual home automation script" with my own callback functions and I thougt this is only possible with server-side programming, isn't it?

[gsaw]

Hi,
I wanted to implement my own "individual home automation script" with my own callback functions and I thougt this is only possible with server-side programming, isn't it?

I think you need a module. A module is just an javascript and with them you can do anything you want. The module is called once the zway server is started. Thus you can define a callback function, register it by e.g. a timer or any virtual device for changes and do any thing provided the V8 engine implements this.

Almost every part/function of zway is a module. And modules are running server side.

[johannes]

Ahh, OK!
And what's the best way to start with it? Do i need to create an own folder inside automation/modules, respectively duplicate an existing module an adapt it to my needs?

called once the zway server is started

Will this new module found automatically after starting the z-way server or do I have to reference it anywhere? Is this the same like an app that I can activate inside the z-wave.me GUI?

[gsaw]

Ahh, OK!
And what's the best way to start with it? Do i need to create an own folder inside automation/modules, respectively duplicate an existing module an adapt it to my needs?

I looked under existing modules for one which almost suitable for my needs and copied whole module folder to automation/userModules/ dir. You have then to adapt json file with definition (rename module), change index.js (same, rename module to avoid collisions with existing one). Probably look in other sub directories and adapt language translations. Now you have a working new module. Then you can rework it for your needs.

Ahh, OK!

called once the zway server is started

Will this new module found automatically after starting the z-way server or do I have to reference it anywhere? Is this the same like an app that I can activate inside the z-wave.me GUI?

Yes, you have to activate the module in GUI. If you done with steps above and restarted z-way server you should have your module under available modules. You add it with (+). Now it is active.

You have to restart server every time if you made any changes on your module.

[johannes]

Thank you!
That's the way I've been looking for!
Why didn't I found any information on http://razberry.z-wave.me about this simple solution?
I really saw the forest for the trees ...

[pz1]

Thank you!
That's the way I've been looking for!
Why didn't I found any information on http://razberry.z-wave.me about this simple solution?
I really saw the forest for the trees ...

Documentation is indeed rather scattered an incomplete. It has grown over time, and deserves a thourough rewrite now.
Did you happen to come across this: http://developer.z-wave.me/?uri=help ? It is more recent. It does focus more on the apps side.