org.bluez.mesh.Application1 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bluez-dbus Show documentation

Java native bluetooth library which uses bluez via dbus (linux only)

The newest version!

package org.bluez.mesh;

import org.freedesktop.dbus.interfaces.DBusInterface;
import org.freedesktop.dbus.types.UInt64;

/**
 * File generated - 2023-02-20.

 * Based on bluez Documentation: mesh-api.txt.

 * 

 * Service: unique name

 * Interface: org.bluez.mesh.Application1

 * 

 * Object path:

 *             <app_root>

 * 

 * Supported properties: 

 * 

 * 	:

 * 

 * 		A 16-bit Bluetooth-assigned Company Identifier of the vendor as

 * 		defined by Bluetooth SIG

 * 

 * 

 * 		A 16-bit vendor-assigned product identifier

 * 

 * 

 * 		A 16-bit vendor-assigned product version identifier

 * 

 * 

 * 		A 16-bit minimum number of replay protection list entries

 * 

 * 

 * 

 */
public interface Application1 extends DBusInterface {

    /**
     * From bluez documentation:

     * 

     * This method is called when the node provisioning initiated

     * by a Join() method call successfully completed.

     * 

     * The token parameter serves as a unique identifier of the

     * particular node. The token must be preserved by the application

     * in order to authenticate itself to the mesh daemon and attach to

     * the network as a mesh node by calling Attach() method or

     * permanently remove the identity of the mesh node by calling

     * Leave() method.

     * 

     * If this method returns an error, the daemon will assume that the

     * application failed to preserve the token, and will remove the

     * freshly created node.

     * 

     * 
     * @param _token token
     */
    void JoinComplete(UInt64 _token);

    /**
     * From bluez documentation:

     * 

     * This method is called when the node provisioning initiated by

     * Join() has failed.

     * 

     * The reason parameter identifies the reason for provisioning

     * failure. The defined values are: "timeout", "bad-pdu",

     * "confirmation-failed", "out-of-resources", "decryption-error",

     * "unexpected-error", "cannot-assign-addresses".

     * 

     * 
     * @param _reason reason
     */
    void JoinFailed(String _reason);

}