Custom asset creation

Custom Deployment
1

Dears,
could you please assist with the instructions on how to create a custom asset (custom icon, attributes etc)? i have looked through several topics in the forum but couldn’t find the right way.

2

Hi!

Currently, you can create custom assets by writing the Java code in a Custom Project.
You can take a look at existing asset types here, and use that as inspiration.

Unfortunately there is no step-by-step guide for this.

By default, we provide this CustomAsset example in the custom project template;

package org.openremote.model.custom;

import org.openremote.model.asset.Asset;
import org.openremote.model.asset.AssetDescriptor;
import org.openremote.model.value.AttributeDescriptor;
import org.openremote.model.value.ValueDescriptor;

import jakarta.persistence.Entity;
import java.util.Optional;

/**
 * This is an example of a custom {@link Asset} type; this must be registered via an
 * {@link org.openremote.model.AssetModelProvider} and must conform to the following requirements:
 *
 * <ul>
 * <li>Must have {@link Entity} annotation
 * <li>Optionally add {@link org.openremote.model.value.ValueDescriptor}s
 * <li>Optionally add {@link org.openremote.model.value.MetaItemDescriptor}s
 * <li>Optionally add {@link org.openremote.model.value.AttributeDescriptor}s
 * <li>Must have a public static final {@link org.openremote.model.asset.AssetDescriptor}
 * <li>Must have a protected no args constructor (for hydrators i.e. JPA/Jackson)
 * <li>For a given {@link Asset} type only one {@link org.openremote.model.asset.AssetDescriptor} can exist
 * <li>{@link org.openremote.model.value.AttributeDescriptor}s that override a super class descriptor cannot change the
 * value type; just the formatting etc.
 * <li>{@link org.openremote.model.value.MetaItemDescriptor}s names must be unique
 * <li>{@link org.openremote.model.value.ValueDescriptor}s names must be unique
 * </ul>
 */
@Entity
public class CustomAsset extends Asset<CustomAsset> {

    public enum CustomValueType {
        ONE,
        TWO,
        THREE
    }

    public static final ValueDescriptor<CustomValueType> CUSTOM_VALUE_TYPE_VALUE_DESCRIPTOR = new ValueDescriptor<>("customValueType", CustomValueType.class);

    public static final AttributeDescriptor<CustomValueType> CUSTOM_VALUE_TYPE_ATTRIBUTE_DESCRIPTOR = new AttributeDescriptor<>("customAttribute", CUSTOM_VALUE_TYPE_VALUE_DESCRIPTOR);

    public static final AssetDescriptor<CustomAsset> CUSTOM_ASSET_ASSET_DESCRIPTOR = new AssetDescriptor<>("brightness-auto", "00aaaa", CustomAsset.class);

    public Optional<CustomValueType> getCustomAttribute() {
        return getAttributes().getValue(CUSTOM_VALUE_TYPE_ATTRIBUTE_DESCRIPTOR);
    }

    public CustomAsset setCustomAttribute(CustomValueType value) {
        getAttributes().getOrCreate(CUSTOM_VALUE_TYPE_ATTRIBUTE_DESCRIPTOR).setValue(value);
        return this;
    }
}
3

Thanks for a prompt response.
is it possible to share steps to create a Custom asset? at least on a high level without details?