Search in sources :

Example 1 with BridgeType

use of org.eclipse.smarthome.core.thing.type.BridgeType in project smarthome by eclipse.

the class ThingTypeResource method convertToThingTypeDTO.

private ThingTypeDTO convertToThingTypeDTO(ThingType thingType, Locale locale) {
    final ConfigDescription configDescription;
    if (thingType.getConfigDescriptionURI() != null) {
        configDescription = this.configDescriptionRegistry.getConfigDescription(thingType.getConfigDescriptionURI(), locale);
    } else {
        configDescription = null;
    }
    List<ConfigDescriptionParameterDTO> parameters;
    List<ConfigDescriptionParameterGroupDTO> parameterGroups;
    if (configDescription != null) {
        ConfigDescriptionDTO configDescriptionDTO = ConfigDescriptionDTOMapper.map(configDescription);
        parameters = configDescriptionDTO.parameters;
        parameterGroups = configDescriptionDTO.parameterGroups;
    } else {
        parameters = new ArrayList<>(0);
        parameterGroups = new ArrayList<>(0);
    }
    final List<ChannelDefinitionDTO> channelDefinitions = convertToChannelDefinitionDTOs(thingType.getChannelDefinitions(), locale);
    if (channelDefinitions == null) {
        return null;
    }
    return new ThingTypeDTO(thingType.getUID().toString(), thingType.getLabel(), thingType.getDescription(), thingType.getCategory(), thingType.isListed(), parameters, channelDefinitions, convertToChannelGroupDefinitionDTOs(thingType.getChannelGroupDefinitions(), locale), thingType.getSupportedBridgeTypeUIDs(), thingType.getProperties(), thingType instanceof BridgeType, parameterGroups, thingType.getExtensibleChannelTypeIds());
}
Also used : ConfigDescriptionParameterDTO(org.eclipse.smarthome.config.core.dto.ConfigDescriptionParameterDTO) ConfigDescriptionParameterGroupDTO(org.eclipse.smarthome.config.core.dto.ConfigDescriptionParameterGroupDTO) ConfigDescriptionDTO(org.eclipse.smarthome.config.core.dto.ConfigDescriptionDTO) ChannelDefinitionDTO(org.eclipse.smarthome.core.thing.dto.ChannelDefinitionDTO) ThingTypeDTO(org.eclipse.smarthome.core.thing.dto.ThingTypeDTO) StrippedThingTypeDTO(org.eclipse.smarthome.core.thing.dto.StrippedThingTypeDTO) ConfigDescription(org.eclipse.smarthome.config.core.ConfigDescription) BridgeType(org.eclipse.smarthome.core.thing.type.BridgeType)

Example 2 with BridgeType

use of org.eclipse.smarthome.core.thing.type.BridgeType in project smarthome by eclipse.

the class ThingTypeI18nLocalizationService method createLocalizedThingType.

public ThingType createLocalizedThingType(Bundle bundle, ThingType thingType, Locale locale) {
    final String label = this.thingTypeI18nUtil.getLabel(bundle, thingType.getUID(), thingType.getLabel(), locale);
    final String description = this.thingTypeI18nUtil.getDescription(bundle, thingType.getUID(), thingType.getDescription(), locale);
    final List<ChannelDefinition> localizedChannelDefinitions = new ArrayList<>(thingType.getChannelDefinitions().size());
    for (final ChannelDefinition channelDefinition : thingType.getChannelDefinitions()) {
        String channelLabel = this.thingTypeI18nUtil.getChannelLabel(bundle, thingType.getUID(), channelDefinition, channelDefinition.getLabel(), locale);
        String channelDescription = this.thingTypeI18nUtil.getChannelDescription(bundle, thingType.getUID(), channelDefinition, channelDefinition.getDescription(), locale);
        if (channelLabel == null || channelDescription == null) {
            ChannelType channelType = channelTypeRegistry.getChannelType(channelDefinition.getChannelTypeUID(), locale);
            if (channelType != null) {
                if (channelLabel == null) {
                    channelLabel = this.thingTypeI18nUtil.getChannelLabel(bundle, channelType.getUID(), channelType.getLabel(), locale);
                }
                if (channelDescription == null) {
                    channelDescription = this.thingTypeI18nUtil.getChannelDescription(bundle, channelType.getUID(), channelType.getDescription(), locale);
                }
            }
        }
        localizedChannelDefinitions.add(new ChannelDefinition(channelDefinition.getId(), channelDefinition.getChannelTypeUID(), channelDefinition.getProperties(), channelLabel, channelDescription));
    }
    final List<ChannelGroupDefinition> localizedChannelGroupDefinitions = new ArrayList<>(thingType.getChannelGroupDefinitions().size());
    for (final ChannelGroupDefinition channelGroupDefinition : thingType.getChannelGroupDefinitions()) {
        String channelGroupLabel = this.thingTypeI18nUtil.getChannelGroupLabel(bundle, thingType.getUID(), channelGroupDefinition, channelGroupDefinition.getLabel(), locale);
        String channelGroupDescription = this.thingTypeI18nUtil.getChannelGroupDescription(bundle, thingType.getUID(), channelGroupDefinition, channelGroupDefinition.getDescription(), locale);
        if (channelGroupLabel == null || channelGroupDescription == null) {
            ChannelGroupType channelGroupType = channelTypeRegistry.getChannelGroupType(channelGroupDefinition.getTypeUID(), locale);
            if (channelGroupType != null) {
                if (channelGroupLabel == null) {
                    channelGroupLabel = this.thingTypeI18nUtil.getChannelGroupLabel(bundle, channelGroupType.getUID(), channelGroupType.getLabel(), locale);
                }
                if (channelGroupDescription == null) {
                    channelGroupDescription = this.thingTypeI18nUtil.getChannelGroupDescription(bundle, channelGroupType.getUID(), channelGroupType.getDescription(), locale);
                }
            }
        }
        localizedChannelGroupDefinitions.add(new ChannelGroupDefinition(channelGroupDefinition.getId(), channelGroupDefinition.getTypeUID(), channelGroupLabel, channelGroupDescription));
    }
    ThingTypeBuilder builder = ThingTypeBuilder.instance(thingType).withLabel(label).withDescription(description).withChannelDefinitions(localizedChannelDefinitions).withChannelGroupDefinitions(localizedChannelGroupDefinitions);
    if (thingType instanceof BridgeType) {
        return builder.buildBridge();
    }
    return builder.build();
}
Also used : ThingTypeBuilder(org.eclipse.smarthome.core.thing.type.ThingTypeBuilder) ChannelDefinition(org.eclipse.smarthome.core.thing.type.ChannelDefinition) ArrayList(java.util.ArrayList) ChannelGroupType(org.eclipse.smarthome.core.thing.type.ChannelGroupType) ChannelType(org.eclipse.smarthome.core.thing.type.ChannelType) ChannelGroupDefinition(org.eclipse.smarthome.core.thing.type.ChannelGroupDefinition) BridgeType(org.eclipse.smarthome.core.thing.type.BridgeType)

Example 3 with BridgeType

use of org.eclipse.smarthome.core.thing.type.BridgeType in project smarthome by eclipse.

the class ThingTypesTest method thingTypesShouldLoad.

@Test
public void thingTypesShouldLoad() throws Exception {
    int initialNumberOfThingTypes = thingTypeProvider.getThingTypes(null).size();
    // install test bundle
    Bundle bundle = SyntheticBundleInstaller.install(bundleContext, TEST_BUNDLE_NAME);
    assertThat(bundle, is(notNullValue()));
    Collection<ThingType> thingTypes = thingTypeProvider.getThingTypes(null);
    assertThat(thingTypes.size(), is(initialNumberOfThingTypes + 3));
    BridgeType bridgeType = (BridgeType) thingTypes.stream().filter(it -> it.toString().equals("hue:bridge")).findFirst().get();
    assertThat(bridgeType, is(notNullValue()));
    assertThat(bridgeType.getCategory(), is("NetworkAppliance"));
    assertThat(bridgeType.isListed(), is(false));
    assertThat(bridgeType.getLabel(), is("HUE Bridge"));
    assertThat(bridgeType.getDescription(), is("The hue Bridge represents the Philips hue bridge."));
    assertThat(bridgeType.getProperties().size(), is(1));
    assertThat(bridgeType.getProperties().get("vendor"), is("Philips"));
    assertThat(bridgeType.getRepresentationProperty(), is("serialNumber"));
    ThingType thingType = thingTypes.stream().filter(it -> it.toString().equals("hue:lamp")).findFirst().get();
    assertThat(thingType, is(notNullValue()));
    assertThat(thingType.getCategory(), is("Lightbulb"));
    assertThat(thingType.isListed(), is(false));
    assertThat(thingType.getLabel(), is("HUE Lamp"));
    assertThat(thingType.getDescription(), is("My own great HUE Lamp."));
    assertThat(thingType.getSupportedBridgeTypeUIDs().size(), is(1));
    assertThat(thingType.getSupportedBridgeTypeUIDs().get(0), is("hue:bridge"));
    assertThat(thingType.getExtensibleChannelTypeIds(), containsInAnyOrder("alarm", "brightness"));
    assertThat(thingType.getProperties().size(), is(2));
    assertThat(thingType.getProperties().get("key1"), is("value1"));
    assertThat(thingType.getProperties().get("key2"), is("value2"));
    assertThat(thingType.getRepresentationProperty(), is("uniqueId"));
    List<ChannelDefinition> channelDefinitions = thingType.getChannelDefinitions();
    assertThat(channelDefinitions.size(), is(3));
    ChannelDefinition colorChannel = channelDefinitions.stream().filter(it -> it.getId().equals("color")).findFirst().get();
    assertThat(colorChannel, is(notNullValue()));
    assertThat(colorChannel.getProperties().size(), is(2));
    assertThat(colorChannel.getProperties().get("chan.key1"), is("value1"));
    assertThat(colorChannel.getProperties().get("chan.key2"), is("value2"));
    ChannelType colorChannelType = channelTypeRegistry.getChannelType(colorChannel.getChannelTypeUID());
    assertThat(colorChannelType, is(notNullValue()));
    assertThat(colorChannelType.toString(), is("hue:color"));
    assertThat(colorChannelType.getItemType(), is("ColorItem"));
    assertThat(colorChannelType.getLabel(), is("HUE Lamp Color"));
    assertThat(colorChannelType.getDescription(), is("The color channel allows to control the color of the hue lamp. It is also possible to dim values and switch the lamp on and off."));
    Set<String> tags = colorChannelType.getTags();
    assertThat(tags, is(notNullValue()));
    assertThat(tags.contains("Hue"), is(true));
    assertThat(tags.contains("ColorLamp"), is(true));
    assertThat(tags.contains("AmbientLamp"), is(false));
    assertThat(tags.contains("AlarmSystem"), is(false));
    ChannelDefinition colorTemperatureChannel = channelDefinitions.stream().filter(it -> it.getId().equals("color_temperature")).findFirst().get();
    assertThat(colorTemperatureChannel, is(notNullValue()));
    assertThat(colorTemperatureChannel.getProperties().size(), is(0));
    ChannelType colorTemperatureChannelType = channelTypeRegistry.getChannelType(colorTemperatureChannel.getChannelTypeUID());
    assertThat(colorTemperatureChannelType, is(notNullValue()));
    assertThat(colorTemperatureChannelType.toString(), is("hue:color_temperature"));
    assertThat(colorTemperatureChannelType.getItemType(), is("DimmerItem"));
    assertThat(colorTemperatureChannelType.getLabel(), is("HUE Lamp Color Temperature"));
    assertThat(colorTemperatureChannelType.getDescription(), is("The color temperature channel allows to set the color temperature from 0 (cold) to 100 (warm)."));
    tags = colorTemperatureChannelType.getTags();
    assertThat(tags, is(notNullValue()));
    assertThat(tags.contains("Hue"), is(true));
    assertThat(tags.contains("AmbientLamp"), is(true));
    assertThat(tags.contains("ColorLamp"), is(false));
    assertThat(tags.contains("AlarmSystem"), is(false));
    ChannelDefinition alarmChannel = channelDefinitions.stream().filter(it -> it.getId().equals("alarm")).findFirst().get();
    assertThat(alarmChannel, is(notNullValue()));
    ChannelType alarmChannelType = channelTypeRegistry.getChannelType(alarmChannel.getChannelTypeUID());
    assertThat(alarmChannelType, is(notNullValue()));
    assertThat(alarmChannelType.toString(), is("hue:alarm"));
    assertThat(alarmChannelType.getItemType(), is("Number"));
    assertThat(alarmChannelType.getLabel(), is("Alarm System"));
    assertThat(alarmChannelType.getDescription(), is("The light blinks if alarm is set."));
    tags = alarmChannelType.getTags();
    assertThat(tags, is(notNullValue()));
    assertThat(tags.contains("Hue"), is(true));
    assertThat(tags.contains("AlarmSystem"), is(true));
    assertThat(tags.contains("AmbientLamp"), is(false));
    assertThat(tags.contains("ColorLamp"), is(false));
    assertThat(alarmChannelType.getCategory(), is(equalTo("ALARM")));
    StateDescription state = alarmChannelType.getState();
    assertThat(state.getMinimum(), is(BigDecimal.ZERO));
    assertThat(state.getMaximum(), is(BigDecimal.valueOf(100.0)));
    assertThat(state.getStep(), is(BigDecimal.valueOf(10.0)));
    assertThat(state.getPattern(), is(equalTo("%d Peek")));
    assertThat(state.isReadOnly(), is(true));
    assertThat(state.getOptions().size(), is(2));
    assertThat(state.getOptions().get(0).getValue(), is(equalTo("SOUND")));
    assertThat(state.getOptions().get(0).getLabel(), is(equalTo("My great sound.")));
    thingType = thingTypes.stream().filter(it -> it.toString().equals("hue:lamp-with-group")).findFirst().get();
    assertThat(thingType.getProperties().size(), is(0));
    assertThat(thingType.getCategory(), is(nullValue()));
    assertThat(thingType.isListed(), is(true));
    assertThat(thingType.getExtensibleChannelTypeIds(), containsInAnyOrder("brightness", "alarm"));
    // uninstall test bundle
    bundle.uninstall();
    assertThat(bundle.getState(), is(Bundle.UNINSTALLED));
}
Also used : CoreMatchers(org.hamcrest.CoreMatchers) JavaOSGiTest(org.eclipse.smarthome.test.java.JavaOSGiTest) IsIterableContainingInAnyOrder.containsInAnyOrder(org.hamcrest.collection.IsIterableContainingInAnyOrder.containsInAnyOrder) Collection(java.util.Collection) SyntheticBundleInstaller(org.eclipse.smarthome.test.SyntheticBundleInstaller) Set(java.util.Set) Test(org.junit.Test) Assert.assertThat(org.junit.Assert.assertThat) BigDecimal(java.math.BigDecimal) ChannelDefinition(org.eclipse.smarthome.core.thing.type.ChannelDefinition) List(java.util.List) ChannelType(org.eclipse.smarthome.core.thing.type.ChannelType) ChannelTypeRegistry(org.eclipse.smarthome.core.thing.type.ChannelTypeRegistry) ThingTypeProvider(org.eclipse.smarthome.core.thing.binding.ThingTypeProvider) After(org.junit.After) BridgeType(org.eclipse.smarthome.core.thing.type.BridgeType) StateDescription(org.eclipse.smarthome.core.types.StateDescription) ThingType(org.eclipse.smarthome.core.thing.type.ThingType) Bundle(org.osgi.framework.Bundle) BundleException(org.osgi.framework.BundleException) Before(org.junit.Before) Bundle(org.osgi.framework.Bundle) ChannelDefinition(org.eclipse.smarthome.core.thing.type.ChannelDefinition) ThingType(org.eclipse.smarthome.core.thing.type.ThingType) ChannelType(org.eclipse.smarthome.core.thing.type.ChannelType) BridgeType(org.eclipse.smarthome.core.thing.type.BridgeType) StateDescription(org.eclipse.smarthome.core.types.StateDescription) JavaOSGiTest(org.eclipse.smarthome.test.java.JavaOSGiTest) Test(org.junit.Test)

Aggregations

BridgeType (org.eclipse.smarthome.core.thing.type.BridgeType)3 ChannelDefinition (org.eclipse.smarthome.core.thing.type.ChannelDefinition)2 ChannelType (org.eclipse.smarthome.core.thing.type.ChannelType)2 BigDecimal (java.math.BigDecimal)1 ArrayList (java.util.ArrayList)1 Collection (java.util.Collection)1 List (java.util.List)1 Set (java.util.Set)1 ConfigDescription (org.eclipse.smarthome.config.core.ConfigDescription)1 ConfigDescriptionDTO (org.eclipse.smarthome.config.core.dto.ConfigDescriptionDTO)1 ConfigDescriptionParameterDTO (org.eclipse.smarthome.config.core.dto.ConfigDescriptionParameterDTO)1 ConfigDescriptionParameterGroupDTO (org.eclipse.smarthome.config.core.dto.ConfigDescriptionParameterGroupDTO)1 ThingTypeProvider (org.eclipse.smarthome.core.thing.binding.ThingTypeProvider)1 ChannelDefinitionDTO (org.eclipse.smarthome.core.thing.dto.ChannelDefinitionDTO)1 StrippedThingTypeDTO (org.eclipse.smarthome.core.thing.dto.StrippedThingTypeDTO)1 ThingTypeDTO (org.eclipse.smarthome.core.thing.dto.ThingTypeDTO)1 ChannelGroupDefinition (org.eclipse.smarthome.core.thing.type.ChannelGroupDefinition)1 ChannelGroupType (org.eclipse.smarthome.core.thing.type.ChannelGroupType)1 ChannelTypeRegistry (org.eclipse.smarthome.core.thing.type.ChannelTypeRegistry)1 ThingType (org.eclipse.smarthome.core.thing.type.ThingType)1