DeviceOperator (JetLinks Core 1.1.9 API)

所有超级接口:

Configurable, Thing, Wrapper

所有已知实现类:

DefaultDeviceOperator
```
public interface DeviceOperator
extends Thing
```
设备操作接口,用于发送指令到设备messageSender()以及获取配置等相关信息

从以下版本开始:

1.0.0

作者:

zhouhao

方法概要

所有方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`reactor.core.publisher.Mono<AuthenticationResponse>`	`authenticate(AuthenticationRequest request)` 进行授权
`reactor.core.publisher.Mono<Byte>`	`checkState()` 检查设备的真实状态,此操作将检查设备真实的状态.
`reactor.core.publisher.Mono<Boolean>`	`disconnect()` 断开设备连接
`reactor.core.publisher.Mono<String>`	`getAddress()` 获取设备地址,通常是ip地址.
`reactor.core.publisher.Mono<String>`	`getConnectionServerId()`
`String`	`getDeviceId()`
`reactor.core.publisher.Mono<DeviceMetadata>`	`getMetadata()` 获取当前物的物模型,如果当前物没有单独配置物模型,则获取模版里的物模型
`reactor.core.publisher.Mono<Long>`	`getOfflineTime()`
`reactor.core.publisher.Mono<Long>`	`getOnlineTime()`
`reactor.core.publisher.Mono<DeviceProductOperator>`	`getProduct()`
`reactor.core.publisher.Mono<ProtocolSupport>`	`getProtocol()`
`default <V> reactor.core.publisher.Mono<V>`	`getSelfConfig(ConfigKey<V> key)` 获取设备自身的配置
`reactor.core.publisher.Mono<Value>`	`getSelfConfig(String key)` 获取设备自身的配置,如果配置不存在则返回`Mono.empty()`
`reactor.core.publisher.Mono<Values>`	`getSelfConfigs(Collection<String> keys)` 获取设备自身的多个配置,不会返回`Mono.empty()`,通过从`Values`中获取对应的值
`default reactor.core.publisher.Mono<Values>`	`getSelfConfigs(ConfigKey<?>... keys)` 获取设备自身的多个配置
`default reactor.core.publisher.Mono<Values>`	`getSelfConfigs(String... keys)` 获取设备自身的多个配置
`reactor.core.publisher.Mono<String>`	`getSessionId()`
`reactor.core.publisher.Mono<Byte>`	`getState()` 获取设备当前缓存的状态,此状态可能与实际的状态不一致.
`default reactor.core.publisher.Mono<DeviceProductOperator>`	`getTemplate()` 获取当前物使用的模版
`default ThingType`	`getType()`
`default reactor.core.publisher.Mono<Boolean>`	`isOnline()`
`DeviceMessageSender`	`messageSender()`
`reactor.core.publisher.Mono<Boolean>`	`offline()` 设置设备离线
`default reactor.core.publisher.Mono<Boolean>`	`online(String serverId, String sessionId)` 设备上线,通常不需要手动调用
`reactor.core.publisher.Mono<Boolean>`	`online(String serverId, String sessionId, String address)`
`reactor.core.publisher.Mono<Boolean>`	`putState(byte state)`
`reactor.core.publisher.Mono<Void>`	`resetMetadata()` 重置当前设备的独立物模型
`reactor.core.publisher.Mono<Void>`	`setAddress(String address)` 设置设备地址
`reactor.core.publisher.Mono<Boolean>`	`updateMetadata(String metadata)` 设置当前设备的独立物模型,如果没有设置,这使用产品的物模型配置

从接口继承的方法 org.jetlinks.core.things.Thing
getId, rpc, updateMetadata

从接口继承的方法 org.jetlinks.core.Configurable
getAndRemoveConfig, getConfig, getConfig, getConfigs, getConfigs, getConfigs, refreshAllConfig, refreshConfig, removeConfig, removeConfigs, removeConfigs, setConfig, setConfig, setConfig, setConfigs, setConfigs

从接口继承的方法 org.jetlinks.core.Wrapper
isWrapperFor, unwrap

- 方法详细资料
  - getType
```
default ThingType getType()
```
    指定者:
    
    getType 在接口中 Thing
    
    返回:
    
    物类型
  - getDeviceId
```
String getDeviceId()
```
    返回:
    
    设备ID
  - getConnectionServerId
```
reactor.core.publisher.Mono<String> getConnectionServerId()
```
    返回:
    
    当前设备连接所在服务器ID，如果设备未上线 DeviceState.online，则返回null
  - getSessionId
```
reactor.core.publisher.Mono<String> getSessionId()
```
    返回:
    
    当前设备连接会话ID
  - getAddress
```
reactor.core.publisher.Mono<String> getAddress()
```
    获取设备地址,通常是ip地址.
    
    返回:
    
    地址
  - setAddress
```
reactor.core.publisher.Mono<Void> setAddress(String address)
```
    设置设备地址
    
    参数:
    
    address - 地址
    
    返回:
    
    Mono
  - putState
```
reactor.core.publisher.Mono<Boolean> putState(byte state)
```
    参数:
    
    state - 状态
    
    另请参阅:
    
    DeviceState.online
  - getState
```
reactor.core.publisher.Mono<Byte> getState()
```
    获取设备当前缓存的状态,此状态可能与实际的状态不一致.
    
    返回:
    
    获取当前状态
    
    另请参阅:
    
    DeviceState
  - checkState
```
reactor.core.publisher.Mono<Byte> checkState()
```
    检查设备的真实状态,此操作将检查设备真实的状态. 如果设备协议中指定了ProtocolSupport.getStateChecker(),则将调用指定的状态检查器进行检查.
    默认的状态检查逻辑:
    
    另请参阅:
    
    DeviceStateChecker
  - getOnlineTime
```
reactor.core.publisher.Mono<Long> getOnlineTime()
```
    返回:
    
    上线时间
  - getOfflineTime
```
reactor.core.publisher.Mono<Long> getOfflineTime()
```
    返回:
    
    离线时间
  - online
```
default reactor.core.publisher.Mono<Boolean> online(String serverId,
                                                    String sessionId)
```
    设备上线,通常不需要手动调用
    
    参数:
    
    serverId - 设备所在服务ID
    
    sessionId - 会话ID
  - online
```
reactor.core.publisher.Mono<Boolean> online(String serverId,
                                            String sessionId,
                                            String address)
```
  - getSelfConfig
```
reactor.core.publisher.Mono<Value> getSelfConfig(String key)
```
    获取设备自身的配置,如果配置不存在则返回Mono.empty()
    
    指定者:
    
    getSelfConfig 在接口中 Thing
    
    参数:
    
    key - 配置Key
    
    返回:
    
    配置值
  - getSelfConfigs
```
reactor.core.publisher.Mono<Values> getSelfConfigs(Collection<String> keys)
```
    获取设备自身的多个配置,不会返回Mono.empty(),通过从Values中获取对应的值
    
    指定者:
    
    getSelfConfigs 在接口中 Thing
    
    参数:
    
    keys - 配置key列表
    
    返回:
    
    配置值
  - getSelfConfigs
```
default reactor.core.publisher.Mono<Values> getSelfConfigs(String... keys)
```
    获取设备自身的多个配置
    
    指定者:
    
    getSelfConfigs 在接口中 Thing
    
    参数:
    
    keys - 配置key列表
    
    返回:
    
    配置值
  - getSelfConfig
```
default <V> reactor.core.publisher.Mono<V> getSelfConfig(ConfigKey<V> key)
```
    获取设备自身的配置
    
    指定者:
    
    getSelfConfig 在接口中 Thing
    
    参数:
    
    key - 配置key
    
    返回:
    
    配置值
    
    另请参阅:
    
    DeviceConfigKey
  - getSelfConfigs
```
default reactor.core.publisher.Mono<Values> getSelfConfigs(ConfigKey<?>... keys)
```
    获取设备自身的多个配置
    
    指定者:
    
    getSelfConfigs 在接口中 Thing
    
    参数:
    
    keys - 配置key
    
    返回:
    
    配置值
    
    另请参阅:
    
    DeviceConfigKey
  - isOnline
```
default reactor.core.publisher.Mono<Boolean> isOnline()
```
    返回:
    
    是否在线
  - offline
```
reactor.core.publisher.Mono<Boolean> offline()
```
    设置设备离线
    
    另请参阅:
    
    DeviceState.offline
  - disconnect
```
reactor.core.publisher.Mono<Boolean> disconnect()
```
    断开设备连接
    
    返回:
    
    断开结果
  - authenticate
```
reactor.core.publisher.Mono<AuthenticationResponse> authenticate(AuthenticationRequest request)
```
    进行授权
    
    参数:
    
    request - 授权请求
    
    返回:
    
    授权结果
    
    另请参阅:
    
    MqttAuthenticationRequest
  - getMetadata
```
reactor.core.publisher.Mono<DeviceMetadata> getMetadata()
```
    从接口复制的说明: Thing
    
    获取当前物的物模型,如果当前物没有单独配置物模型,则获取模版里的物模型
    
    指定者:
    
    getMetadata 在接口中 Thing
    
    返回:
    
    获取设备的元数据
  - getProtocol
```
reactor.core.publisher.Mono<ProtocolSupport> getProtocol()
```
    返回:
    
    获取此设备使用的协议支持
  - messageSender
```
DeviceMessageSender messageSender()
```
    返回:
    
    消息发送器, 用于发送消息给设备
  - updateMetadata
```
reactor.core.publisher.Mono<Boolean> updateMetadata(String metadata)
```
    设置当前设备的独立物模型,如果没有设置,这使用产品的物模型配置
    
    指定者:
    
    updateMetadata 在接口中 Thing
    
    参数:
    
    metadata - 物模型
    
    返回:
    
    true
  - resetMetadata
```
reactor.core.publisher.Mono<Void> resetMetadata()
```
    重置当前设备的独立物模型
    
    指定者:
    
    resetMetadata 在接口中 Thing
    
    返回:
    
    void
    
    从以下版本开始:
    
    1.1.6
  - getProduct
```
reactor.core.publisher.Mono<DeviceProductOperator> getProduct()
```
    返回:
    
    获取设备对应的产品操作接口
  - getTemplate
```
default reactor.core.publisher.Mono<DeviceProductOperator> getTemplate()
```
    从接口复制的说明: Thing
    
    获取当前物使用的模版
    
    指定者:
    
    getTemplate 在接口中 Thing
    
    返回:
    
    当前物使用的模版

接口 DeviceOperator

方法概要

从接口继承的方法 org.jetlinks.core.things.Thing

从接口继承的方法 org.jetlinks.core.Configurable

从接口继承的方法 org.jetlinks.core.Wrapper

方法详细资料

getType

getDeviceId

getConnectionServerId

getSessionId

getAddress

setAddress

putState

getState

checkState

getOnlineTime

getOfflineTime

online

online

getSelfConfig

getSelfConfigs

getSelfConfigs

getSelfConfig

getSelfConfigs

isOnline

offline

disconnect

authenticate

getMetadata

getProtocol

messageSender

updateMetadata

resetMetadata

getProduct

getTemplate