https://github.com/canonical/dbus.dart

Native Dart client library to use DBus.
https://github.com/canonical/dbus.dart

dart

Last synced: about 1 month ago
JSON representation

Native Dart client library to use DBus.

• Host: GitHub
• URL: https://github.com/canonical/dbus.dart
• Owner: canonical
• License: mpl-2.0
• Created: 2019-11-20T14:30:12.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-07-03T14:18:37.000Z (3 months ago)
• Last Synced: 2024-07-22T23:51:18.443Z (about 2 months ago)
• Topics: dart
• Language: Dart
• Homepage: https://pub.dev/packages/dbus
• Size: 630 KB
• Stars: 92
• Watchers: 8
• Forks: 32
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-flutter-desktop - dbus - A native Dart implementation of the D-Bus message bus client. This package allows Dart applications to directly access services on the Linux desktop. (Packages)

README

        
[![Pub Package](https://img.shields.io/pub/v/dbus.svg)](https://pub.dev/packages/dbus)

[![codecov](https://codecov.io/gh/canonical/dbus.dart/branch/main/graph/badge.svg?token=rk7NBXldfn)](https://codecov.io/gh/canonical/dbus.dart)

A native Dart client implementation of [D-Bus](https://www.freedesktop.org/wiki/Software/dbus/).

## Accessing remote objects

The easiest way to get started is to generate Dart classes from a D-Bus interface definition, for example:

```xml

  

    

    

      

      

    

  

```

The *dart-dbus* tool processes this interface to generate a Dart source file:

```shell

$ dart-dbus generate-remote-object test-object.xml -o test-remote-object.dart

```

You can then use the generated `test-remote-object.dart` to access that remote object from your program:

```dart

import 'package:dbus/dbus.dart';

import 'test-remote-object.dart';

Future main() async {

  var client = DBusClient.session();

  var object = ComExampleTestObject(client, 'com.example.Test');

  var version = await object.getVersion();

  print('version: $version');

  var reversedText = await object.callReverseText('Hello World');

  print(reversedText);

  await client.close();

}

```

The code generated by *dart-dbus* may not be the cleanest API you want to expose for your service. It is recommended that you use the generated code as a starting point and then modify it as necessary.

## Exporting local objects

The above interface definition can also be processed to generate a class for exporting this object.

```shell

$ dart-dbus generate-object test-object.xml -o test-object.dart

```

You can then use the generated `test-object.dart` in your program:

```dart

import 'package:dbus/dbus.dart';

import 'test-object.dart';

class TestObject extends ComExampleTestObject {

  @override

  Future getVersion() async {

    return DBusGetPropertyResponse(DBusString('1.2'));

  }

  @override

  Future doReverseText(String input) async {

    var reversedText = String.fromCharCodes(input.codeUnits.reversed);

    return DBusMethodSuccessResponse([DBusString(reversedText)]);

  }

}

Future main() async {

  var client = DBusClient.session();

  await client.requestName('com.example.Test');

  await client.registerObject(TestObject());

}

```

## Using objects without *dbus-dart*

You can also choose to access D-Bus objects directly without interface definitions and *dbus-dart*.

This requires writing more code and handing more error cases.

The following code shows how to access the remote object in the above examples:

```dart

import 'package:dbus/dbus.dart';

Future main() async {

  var client = DBusClient.session();

  var object = DBusRemoteObject(client, name: 'com.example.Test', path: DBusObjectPath('/com/example/Test/Object'));

  var value = await object.getProperty('com.example.Test', 'Version', signature: DBusSignature('s'));

  var version = value.asString();

  print('version: $version');

  var response = await object.callMethod('com.example.Test', 'ReverseText', [DBusString('Hello World')], replySignature: DBusSignature('s'));

  var reversedText = response.values[0].asString();

  print('$reversedText');

  await client.close();

}

```

And the following shows how to export that object:

```dart

import 'package:dbus/dbus.dart';

class TestObject extends DBusObject {

  TestObject() : super(DBusObjectPath('/com/example/Test/Object'));

  @override

  Future getProperty(String interface, String name) async {

    if (interface == 'com.example.Test' && name == 'Version') {

      return DBusGetPropertyResponse(DBusString('1.2'));

    } else {

      return DBusMethodErrorResponse.unknownProperty();

    }

  }

  @override

  Future handleMethodCall(DBusMethodCall methodCall) async {

    if (methodCall.interface == 'com.example.Test') {

      if (methodCall.name == 'ReverseText') {

        if (methodCall.signature != DBusSignature('s')) {

          return DBusMethodErrorResponse.invalidArgs();

        }

	var input = methodCall.values[0].asString();

        var reversedText = String.fromCharCodes(input.codeUnits.reversed);

        return DBusMethodSuccessResponse([DBusString(reversedText)]);

      } else {

        return DBusMethodErrorResponse.unknownMethod();

      }

    } else {

      return DBusMethodErrorResponse.unknownInterface();

    }

  }

}

Future main() async {

  var client = DBusClient.session();

  await client.requestName('com.example.Test');

  await client.registerObject(TestObject());

}

```

## Contributing to dbus.dart

We welcome contributions! See the [contribution guide](CONTRIBUTING.md) for more details.