Best way to get started is by looking at the examples. After the build:
Navigate to path/to/dbus/examples folder
Run node service.js &
Run node hello.js
Work your way through other examples to explore supported functionality.
Note on systems without X11
If no X server is running, the module fails when attempting to obtain a D-Bus
connection at DBus.getBus(). This can be remedied by setting two environment
variables manually (the actual bus address might be different):
Connect to a bus. busName must be either "system" to connect to the system
bus or "session" to connect to the session bus.
Returns a Bus.
var bus = DBus.getBus('session');
DBus.registerService(busName, serviceName)
busName <string>
serviceName <string>
Register a service on a specific bus. This allows the caller to create a DBus
service.
busName must be either "system" to create the service on the system bus, or
"session" to create the service on the session bus. Note: the system bus
often has security requirements that need to be met before the service can be
registered.
Returns a Service.
var service = DBus.registerService('session', 'com.example.Library');
serviceName <string> - The well-known name of the service that owns the object.
objectPath <string> - The path of the object.
interfaceName <string> - Which of the object's interfaces to retrieve.
callback <function>
Get an existing object's interface from a well-known service.
Once retrieved, callback will be called with either an error or with an
Interface.
bus.getInterface('com.example.Library', '/com/example/Library/authors/DAdams', 'com.example.Library.Author1', function(err, interface) { if (err) { ... } // Do something with the interface});
Bus.prototype.disconnect()
Disconnect from DBus. This disconnection makes it so that Node isn't kept
running based on this active connection. It also makes this bus, and all of its
children (interfaces that have been retrieved, etc.) unusable.
Get the value of all of the properties of the interface.
Once retrieved callback will be called with either an error or with an object
where the keys are the names of the properties, and the values are the values
of those properties.
methodName <string> - The name of the method on the interface to call.
...args <any> - The arguments that must be passed to the method.
options <object> - The options that can be set. This is optional.
options.timeout <number> - The number of milliseconds to wait before the
request is timed out. This defaults to -1: don't time out.
callback <function>
Call a method on the interface.
Once executed, callback will be called with either an error or with the
result of the method call.
interface.AddBook("The Hitchhiker's Guide to the Galaxy", { timeout: 1000 }, function(err, result) {})
Service
A dbus service created by the application.
Service.prototype.createObject(objectPath)
objectPath <string> - The path of the object. E.g., /com/example/ObjectName
Create an object that is exposed over DBus.
Returns a ServiceObject.
var object = service.createObject('/com/example/Library/authors/DAdams');
Service.prototype.removeObject(object)
object <ServiceObject> - the service object that has been created
Remove (or unexpose) an object that has been created.
service.removeObject(object);
Service.prototype.disconnect()
Disconnect from DBus. This disconnection makes it so that Node isn't kept
running based on this active connection. It also disconnects all of the objects
created by this service.
interface.emit('bookCreated', { name: "The Hitchhiker's Guide to the Galaxy" })
ServiceInterface.prototype.update()
Save interface updates after making changes. After changes to the interface are
made (via addMethod, addProperty, and addSignal), update must be called
to ensure that other DBus clients can see the changes that were made.
DBus.Error
A DBus-specific error
new DBus.Error(name, message)
name <string> - A valid DBus Error name, according to the specification
message <string> - A human readable message
Create a new error. The name must be a valid error name.
throw new DBus.Error('com.example.Library.Error.BookExistsError', 'The book already exists');
dbusError.dbusName
The DBus Error name of the error. When a DBus.Error is created, its message is
set to the human-readable error message. The dbusName property is set to the
name (according to the DBus Spec).
License
(The MIT License)
Copyright (c) 2013
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.