Package org.bluez.mesh

Interface Node1

All Superinterfaces:
org.freedesktop.dbus.interfaces.DBusInterface
public interface Node1 extends org.freedesktop.dbus.interfaces.DBusInterface
File generated - 2023-02-20.
Based on bluez Documentation: mesh-api.txt.

Service: org.bluez.mesh
Interface: org.bluez.mesh.Node1

Object path:
/org/bluez/mesh/node<uuid>
where <uuid6gt; is the Device UUID passed to Join(),
CreateNetwork() or Import()

Supported properties:
dict Features [read-only]

The dictionary that contains information about feature support.
The following keys are defined:

boolean Friend

Indicates the ability to establish a friendship with a
Low Power node

boolean LowPower

Indicates support for operating in Low Power node mode

boolean Proxy

Indicates support for GATT proxy

boolean Relay
Indicates support for relaying messages

If a key is absent from the dictionary, the feature is not supported.
Otherwise, true means that the feature is enabled and false means that
the feature is disabled.

boolean Beacon [read-only]

This property indicates whether the periodic beaconing is
enabled (true) or disabled (false).

boolean IvUpdate [read-only]

When true, indicates that the network is in the middle of IV
Index Update procedure. This information is only useful for
provisioning.

uint32 IvIndex [read-only]

This property may be read at any time to determine the IV_Index
that the current network is on. This information is only useful
for provisioning.

uint32 SecondsSinceLastHeard [read-only]

This property may be read at any time to determine the number of
seconds since mesh network layer traffic was last detected on
this node's network.

array{uint16} Addresses [read-only]

This property contains unicast addresses of node's elements.

uint32 SequenceNumber [read-only]

This property may be read at any time to determine the
sequence number.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    AddAppKey(org.freedesktop.dbus.DBusPath _elementPath, org.freedesktop.dbus.types.UInt16 _destination, org.freedesktop.dbus.types.UInt16 _appIndex, org.freedesktop.dbus.types.UInt16 _netIndex, boolean _update)
    From bluez documentation:

    This method is used to send add or update network key originated
    by the local configuration client to a remote configuration
    server.

    The element_path parameter is the object path of an element from
    a collection of the application elements (see Mesh Application
    Hierarchy section).

    The destination parameter contains the destination address.
    void
    AddNetKey(org.freedesktop.dbus.DBusPath _elementPath, org.freedesktop.dbus.types.UInt16 _destination, org.freedesktop.dbus.types.UInt16 _subnetIndex, org.freedesktop.dbus.types.UInt16 _netIndex, boolean _update)
    From bluez documentation:

    This method is used to send add or update network key originated
    by the local configuration client to a remote configuration
    server.

    The element_path parameter is the object path of an element from
    a collection of the application elements (see Mesh Application
    Hierarchy section).

    The destination parameter contains the destination address.
    void
    DevKeySend(org.freedesktop.dbus.DBusPath _elementPath, org.freedesktop.dbus.types.UInt16 _destination, boolean _remote, org.freedesktop.dbus.types.UInt16 _netIndex, Map<String,org.freedesktop.dbus.types.Variant<?>> _options, byte[] _data)
    From bluez documentation:

    This method is used to send a message originated by a local
    model encoded with the device key of the remote node.

    The element_path parameter is the object path of an element from
    a collection of the application elements (see Mesh Application
    Hierarchy section).

    The destination parameter contains the destination address.
    void
    Publish(org.freedesktop.dbus.DBusPath _elementPath, org.freedesktop.dbus.types.UInt16 _model, Map<String,org.freedesktop.dbus.types.Variant<?>> _options, byte[] _data)
    From bluez documentation:

    This method is used to send a publication originated by a local
    model.
    void
    Send(org.freedesktop.dbus.DBusPath _elementPath, org.freedesktop.dbus.types.UInt16 _destination, org.freedesktop.dbus.types.UInt16 _keyIndex, Map<String,org.freedesktop.dbus.types.Variant<?>> _options, byte[] _data)
    From bluez documentation:

    This method is used to send a message originated by a local
    model.

    The element_path parameter is the object path of an element from
    a collection of the application elements (see Mesh Application
    Hierarchy section).

    The destination parameter contains the destination address.

    Methods inherited from interface org.freedesktop.dbus.interfaces.DBusInterface

    getObjectPath, isRemote

  • Method Details

    • Send

      void Send(org.freedesktop.dbus.DBusPath _elementPath, org.freedesktop.dbus.types.UInt16 _destination, org.freedesktop.dbus.types.UInt16 _keyIndex, Map<String,org.freedesktop.dbus.types.Variant<?>> _options, byte[] _data) throws BluezMeshNotFoundException, BluezMeshInvalidArgumentsException, BluezMeshNotAuthorizedException
      From bluez documentation:

      This method is used to send a message originated by a local
      model.

      The element_path parameter is the object path of an element from
      a collection of the application elements (see Mesh Application
      Hierarchy section).

      The destination parameter contains the destination address. This
      destination must be a uint16 to a unicast address, or a well
      known group address.

      The key_index parameter determines which application key to use
      for encrypting the message. The key_index must be valid for that
      element, i.e., the application key must be bound to a model on
      this element. Otherwise, org.bluez.mesh.Error.NotAuthorized will
      be returned.

      The options parameter is a dictionary with the following keys
      defined: 
            bool ForceSegmented
          Specifies whether to force sending of a short
          message as one-segment payload. If not present,
          the default setting is "false".
      The data parameter is an outgoing message to be encypted by the
      bluetooth-meshd daemon and sent on.
      Parameters:
      _elementPath - element_path
      _destination - destination
      _keyIndex - key_index
      _options - options
      _data - data
      Throws:
      BluezMeshInvalidArgumentsException - when invalid argument given
      BluezMeshNotAuthorizedException - when not authorized
      BluezMeshNotFoundException - when mesh not found

    • DevKeySend

      void DevKeySend(org.freedesktop.dbus.DBusPath _elementPath, org.freedesktop.dbus.types.UInt16 _destination, boolean _remote, org.freedesktop.dbus.types.UInt16 _netIndex, Map<String,org.freedesktop.dbus.types.Variant<?>> _options, byte[] _data) throws BluezMeshInvalidArgumentsException, BluezMeshNotFoundException
      From bluez documentation:

      This method is used to send a message originated by a local
      model encoded with the device key of the remote node.

      The element_path parameter is the object path of an element from
      a collection of the application elements (see Mesh Application
      Hierarchy section).

      The destination parameter contains the destination address. This
      destination must be a uint16 to a unicast address, or a well
      known group address.

      The remote parameter, if true, looks up the device key by the
      destination address in the key database to encrypt the message.
      If remote is true, but requested key does not exist, a NotFound
      error will be returned. If set to false, the local node's
      device key is used.

      The net_index parameter is the subnet index of the network on
      which the message is to be sent.

      The options parameter is a dictionary with the following keys
      defined:

            bool ForceSegmented
          Specifies whether to force sending of a short
          message as one-segment payload. If not present,
          the default setting is "false".

      The data parameter is an outgoing message to be encypted by the
      meshd daemon and sent on.
      Parameters:
      _elementPath - element_path
      _destination - destination
      _remote - remote
      _netIndex - net_index
      _options - options
      _data - data
      Throws:
      BluezMeshInvalidArgumentsException - when invalid argument provided
      BluezMeshNotFoundException - when mesh not found

    • AddNetKey

      void AddNetKey(org.freedesktop.dbus.DBusPath _elementPath, org.freedesktop.dbus.types.UInt16 _destination, org.freedesktop.dbus.types.UInt16 _subnetIndex, org.freedesktop.dbus.types.UInt16 _netIndex, boolean _update) throws BluezMeshInvalidArgumentsException, BluezMeshNotFoundException
      From bluez documentation:

      This method is used to send add or update network key originated
      by the local configuration client to a remote configuration
      server.

      The element_path parameter is the object path of an element from
      a collection of the application elements (see Mesh Application
      Hierarchy section).

      The destination parameter contains the destination address. This
      destination must be a uint16 to a nodes primary unicast address.

      The subnet_index parameter refers to the subnet index of the
      network that is being added or updated. This key must exist in
      the local key database.

      The net_index parameter is the subnet index of the network on
      which the message is to be sent.

      The update parameter indicates if this is an addition or an
      update. If true, the subnet key must be in the phase 1 state of
      the key update procedure.
      Parameters:
      _elementPath - element_path
      _destination - destination
      _subnetIndex - subnet_index
      _netIndex - net_index
      _update - update
      Throws:
      BluezMeshInvalidArgumentsException - when invalid argument provided
      BluezMeshNotFoundException - when mesh not found

    • AddAppKey

      void AddAppKey(org.freedesktop.dbus.DBusPath _elementPath, org.freedesktop.dbus.types.UInt16 _destination, org.freedesktop.dbus.types.UInt16 _appIndex, org.freedesktop.dbus.types.UInt16 _netIndex, boolean _update) throws BluezMeshInvalidArgumentsException, BluezMeshNotFoundException
      From bluez documentation:

      This method is used to send add or update network key originated
      by the local configuration client to a remote configuration
      server.

      The element_path parameter is the object path of an element from
      a collection of the application elements (see Mesh Application
      Hierarchy section).

      The destination parameter contains the destination address. This
      destination must be a uint16 to a nodes primary unicast address.

      The app_index parameter refers to the application key which is
      being added or updated. This key must exist in the local key
      database.

      The net_index parameter is the subnet index of the network on
      which the message is to be sent.

      The update parameter indicates if this is an addition or an
      update. If true, the subnet key must be in the phase 1 state of
      the key update procedure.
      Parameters:
      _elementPath - element_path
      _destination - destination
      _appIndex - app_index
      _netIndex - net_index
      _update - update
      Throws:
      BluezMeshInvalidArgumentsException - when invalid argument provided
      BluezMeshNotFoundException - when mesh not found

    • Publish

      void Publish(org.freedesktop.dbus.DBusPath _elementPath, org.freedesktop.dbus.types.UInt16 _model, Map<String,org.freedesktop.dbus.types.Variant<?>> _options, byte[] _data) throws BluezMeshInvalidArgumentsException, BluezMeshDoesNotExistException
      From bluez documentation:

      This method is used to send a publication originated by a local
      model. If the model does not exist, or it has no publication
      record, the method returns org.bluez.mesh.Error.DoesNotExist
      error.

      The element_path parameter is the object path of an element from
      a collection of the application elements (see Mesh Application
      Hierarchy section).

      The model parameter contains a model ID, as defined by the
      Bluetooth SIG. If the options dictionary contains a "Vendor"
      key, then this ID is defined by the specified vendor.

      The options parameter is a dictionary with the following keys
      defined: 
            bool ForceSegmented
          Specifies whether to force sending of a short
          message as one-segment payload. If not present,
          the default setting is "false".

      uint16 Vendor
          A 16-bit Company ID as defined by the
          Bluetooth SIG. This key should only exist when
          publishing on a Vendor defined model.
      The data parameter is an outgoing message to be encrypted by the
      meshd daemon and sent on.

      Since only one Publish record may exist per element-model, the
      destination and key_index are obtained from the Publication
      record cached by the daemon.
      Parameters:
      _elementPath - element_path
      _model - model
      _options - options
      _data - data
      Throws:
      BluezMeshInvalidArgumentsException - when invalid argument provided
      BluezMeshDoesNotExistException - when mesh does not exist