org.bluez.mesh.Attention1 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.bluez.exceptions.mesh.BluezMeshNotSupportedException;
import org.freedesktop.dbus.interfaces.DBusInterface;
import org.freedesktop.dbus.types.UInt16;

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

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

 * 

 * Service: unique name

 * Interface: org.bluez.mesh.Attention1

 * 

 * Object path:

 *             freely definable

 * 

 */
public interface Attention1 extends DBusInterface {

    /**
     * From bluez documentation:

     * 

     * The element_index parameter is the element's index within the

     * node where the health server model is hosted.

     * 

     * The time parameter indicates how many seconds the attention

     * state shall be on.

     *
     * @param _elementIndex element_index
     * @param _time time
     *
     * @throws BluezMeshNotSupportedException when operation is not supported
     */
    void SetTimer(byte _elementIndex, UInt16 _time) throws BluezMeshNotSupportedException;

    /**
     * From bluez documentation:

     * 

     *  The element parameter is the unicast address within the node

     *  where the health server model is hosted.

     *  

     *  Returns the number of seconds for how long the attention action

     *  remains staying on.
     *
     * @param _element element
     *
     * @return UInt16 - maybe null
     *
     * @throws BluezMeshNotSupportedException when operation is not supported
     */
    UInt16 GetTimer(UInt16 _element) throws BluezMeshNotSupportedException;

}