org.sputnikdev.esh.binding.bluetooth.BluetoothBindingConstants Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.smarthome.binding.bluetooth Show documentation
Eclipse SmartHome Bluetooth Binding
The newest version!
package org.sputnikdev.esh.binding.bluetooth;

import org.eclipse.smarthome.core.thing.ThingTypeUID;

import java.util.Collections;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * The {@link BluetoothBindingConstants} class defines some bluetooth binding constants.
 * 
 * @author Vlad Kolotov
 */
public final class BluetoothBindingConstants {

    private BluetoothBindingConstants() { }

    public static final String BINDING_ID = "bluetooth";
    
    // List of all Thing Type UIDs
    public static final ThingTypeUID THING_TYPE_ADAPTER = new ThingTypeUID(BINDING_ID, "adapter");
    public static final ThingTypeUID THING_TYPE_GENERIC = new ThingTypeUID(BINDING_ID, "generic");
    public static final ThingTypeUID THING_TYPE_BLE = new ThingTypeUID(BINDING_ID, "ble");
    public static final ThingTypeUID THING_TYPE_BEACON = new ThingTypeUID(BINDING_ID, "beacon");

    public static final Set SUPPORTED_THING_TYPES = Collections.unmodifiableSet(Stream.of(
            THING_TYPE_ADAPTER, THING_TYPE_GENERIC, THING_TYPE_BLE, THING_TYPE_BEACON).collect(Collectors.toSet()));

    // List of all Channel ids
    public static final String CHANNEL_CHARACTERISTIC = "characteristic";
    public static final String CHANNEL_CHARACTERISTIC_FIELD = "characteristic-field";
    public static final String CHANNEL_CHARACTERISTIC_ADVANCED_READONLY_FIELD =
            "characteristic-advanced-readonly-field";
    public static final String CHANNEL_CHARACTERISTIC_ADVANCED_EDITABLE_FIELD =
            "characteristic-advanced-editable-field";
    public static final String CHANNEL_CHARACTERISTIC_READONLY_FIELD = "characteristic-readonly-field";
    public static final String CHANNEL_CHARACTERISTIC_EDITABLE_FIELD = "characteristic-editable-field";
    public static final String CHANNEL_RSSI = "rssi";
    public static final String CHANNEL_TX_POWER = "tx-power";
    public static final String CHANNEL_ESTIMATED_DISTANCE = "estimated-distance";
    public static final String CHANNEL_LAST_UPDATED = "last-updated";
    public static final String CHANNEL_CONNECTED = "connected";
    public static final String CHANNEL_CONNECTION_CONTROL = "connection-control";
    public static final String CHANNEL_ONLINE = "online";
    public static final String CHANNEL_DISCOVERING = "discovering";
    public static final String CHANNEL_DISCOVERING_CONTROL = "discovering-control";
    public static final String CHANNEL_LOCATION = "location";
    public static final String CHANNEL_ADAPTER = "adapter";
    public static final String CHANNEL_CONNECTED_ADAPTER = "connected-adapter";
    public static final String CHANNEL_AUTHENTICATED = "authenticated";

    // Thing (device) properties
    public static final String PROPERTY_ADDRESS = "Address";
    public static final String PROPERTY_ADAPTER = "Adapter";

    // Field properties
    public static final String PROPERTY_FIELD_NAME = "FieldName";
    public static final String PROPERTY_FIELD_INDEX = "FieldIndex";

    // Characteristic properties
    public static final String PROPERTY_FLAGS = "Flags";
    public static final String PROPERTY_SERVICE_UUID = "ServiceUUID";
    public static final String PROPERTY_CHARACTERISTIC_UUID = "CharacteristicUUID";

    // Characteristic access flags
    public static final String READ_FLAG = "read";
    public static final String NOTIFY_FLAG = "notify";
    public static final String INDICATE_FLAG = "indicate";
    public static final String WRITE_FLAG = "write";

    // Configuration properties
    public static final int DEFAULT_UPDATE_RATE = 10;
    public static final int DEFAULT_ONLINE_TIMEOUT = 30;
    public static final boolean DEFAULT_CONNECTION_CONTROL = true;
    public static final String DEFAULT_EXTENSION_FOLDER = "/home/pi/.bluetooth_smart";
    public static final String DEFAULT_ADAPTERS_LOCATION = "Bluetooth Adapters";
    public static final String DEFAULT_DEVICES_LOCATION = "Bluetooth Devices";
    public static final int DEFAULT_RSS_REPORTING_RATE = 5000;

}