Lightweight and flexible wrapper for Wialon Remote API
wialonjs-api
helps you to work with Wialon Hosting and Wialon Local
throught Remote API
<script scr='dist/wialon-src.js'></script>
<script>
// create Wialon session instance
var sess = new W.Session('https://hst-api.wialon.com', {
eventsTimeout: 5
});
// set Remote API 'svc' param
var svc = 'core/login';
// set Remote API 'params' param
var params = {
user: 'wialon_test',
password: 'test'
};
// Execute request
sess.execute(svc, params, function(data) {
// callback
console.log('login succeed');
});
</script>
Library all library classes use W
namespace.
The central class of the API. Store all information about session, SID,
cache results, can execute avl_event
automatically, etc.
// Wialon server url
var url = 'https://hst-api.wialon.com';
// internal session options
var options = {
eventsTimeout: 5
};
// create Session instance
var sess = new W.Session(url, options);
// login
sess.execute('core/login', {user: 'wialon_test', password: 'test'}, function (data) {
// login callback
// sid automatically saved, you can exec next request
});
eventsTimeout
Timeout for auto executingavl_evts
request. Set0
to preventavl_evts
request sending. Default: 10 (sec).
execute
Execute Remote API requestgetEvents
Get events from server (execute 'avl_evts' request). Run automaticaly ifoptions.eventsTimeout
!= 0.getBaseUrl
Get session base url (e.g. https://hst-api.wialon.com)getItems
Get items loaded in session by type. Executecore/update_data_flag
before use this method.getItem
Get items loaded in session by id. Executecore/update_data_flag
before use this method.
Helps to performs remote requests
// create Request instance
var req = new W.Request('https://hst-api.wialon.com');
// execute 'core/login' request with 'api' method
req.api(
'core/login',
{user: 'wialon_test', password: 'test'},
function() {
// callback
}
);
// execute 'core/login' request with 'send' method
req.send(
'/wialon/ajax.html?svc=core/login',
{user: 'wialon_test', password: 'test'},
function success() {
// success callback
},
function error() {
// error callback
}
);
api
Execute simple Remote API requestsend
Process request sending
Powers the OOP facilities and is used to create library classes.
var MyClass = W.Class.extend({
initialize: function (greeter) {
this.greeter = greeter;
// class constructor
},
greet: function (name) {
alert(this.greeter + ', ' + name)
}
});
// create instance of MyClass, passing "Hello" to the constructor
var a = new MyClass("Hello");
// call greet method, alerting "Hello, World"
a.greet("World");
Various utility functions, used internally.
Feel free to pull request
We use Jake for building
# global jake install
npm install -g jake
# install dependencies
npm install
# build project
jake
We use JSHint and JSCS to validate code.
Run jake jshint
and jake jscs
to check