onbon.bx06

Class Bx6GScreen

java.lang.Object

onbon.bx06.Bx6GScreen

Direct Known Subclasses:

Bx6GScreenClient, Bx6GScreenRS, Bx6GScreenServer

public abstract class Bx6GScreen
extends java.lang.Object

屏幕控制程式。

See Also:

Bx6GScreen.Result

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Bx6GScreen.Result<T extends onbon.bx06.message.Response> 通讯回应结果。 1.

Method Summary

Methods

Modifier and Type	Method and Description
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	cancelTimingOnOff() 取消定时开关机。
void	changeOutputBuffer(int bufferSize) 改变输出缓存大小。有效范围 512Bytes ~ 64KB。 注意：改变缓存大小前请确认控制卡可接受上限，超过会造成控制卡运作失败。
Bx6GScreen.Result<onbon.bx06.message.led.ReturnControllerStatus>	checkControllerStatus() 查询控制器状态。
Bx6GScreen.Result<onbon.bx06.message.led.ReturnCurrentFirmwareStatus>	checkFirmware() 查询当前固件状态。
Bx6GScreen.Result<onbon.bx06.message.led.ReturnCurrentFirmwareStatus>	checkFirmware(java.lang.String firmwareName) 查询当前固件状态。
Bx6GScreen.Result<onbon.bx06.message.tcp.ReturnHealth>	checkHealth() 读取网路设定，只适用于一般网路模式，当控制器为服务器模式时，回报为 NULL。
Bx6GScreen.Result<onbon.bx06.message.ofs.ReturnMemVolume>	checkMemVolumes() 查询文件系统容量。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	clockBrightness(Bx6GBrightnessClockEnv env) 修改根據時間調整亮度。
ScreenTimingOnOffCmd	createTimingOnOff() 建立定时开关机。设定定时开关机区间后执行 setupTimingOnOff 将结果传送至控制器。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	deleteAllDynamic() 删除所有动态区。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	deleteDynamic(int... dynamicIds) 删除动态区。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	deleteProgram(int programId) 删除控制器上的特定节目。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	deleteProgram(java.lang.String programName) 删除控制器上的特定节目。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	deletePrograms() 删除控制器上所有的节目。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	deletePrograms(int... programIds) 删除控制器上的特定节目组。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	deletePrograms(java.util.List<java.lang.String> programNames) 删除控制器上的特定节目组。
void	disconnect() 断线。
java.lang.String	getAliasName() 取得屏幕名称。
java.lang.String	getControllerAddress() 取得控制器位址。
java.lang.String	getControllerType() 取得控制器类型。
java.lang.String	getId() 取得识别编号。
abstract java.lang.String	getNetId() 取得 Net 编号，ONBON 內部唯一識別碼。 1.
Bx6GScreenProfile	getProfile() 取得当前屏幕规格。屏幕规格在连线成功后自动从控制器上获取，若控制器未加载屏参时回复 NULL。
Bx6GController.RunMode	getRunMode() 取得运行模式。
boolean	isConnected() 是否已经连线。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	lock() 锁定屏幕。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	lockProgram(int programId, int lockDuration) 锁定节目。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	lockProgram(int programId, int lockDuration, byte nonvolatile) 锁定节目。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	lockProgram(java.lang.String programName, int lockDuration) 锁定节目。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	lockProgram(java.lang.String programName, int lockDuration, byte nonvolatile) 锁定节目。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	manualBrightness(byte level) 修改亮度。亮度值 1 ~ 16。
Bx6GScreen.Result<onbon.bx06.message.led.ReturnPingStatus>	ping() Ping 控制器。
Bx6GScreen.Result<onbon.bx06.message.led.ReturnReadBarCode>	readBarCode() 读取 Bar Code。
onbon.bx06.message.file.ControllerConfigFile	readConfig() 同步方式读取控制器上的屏幕参数。
Bx6GScreen.Result<onbon.bx06.message.led.ReturnControllerID>	readControllerId() 读取控制器编号。
ProgramBxFileND	readProgram(int programId) 同步方式读取控制器上的档案并保存在本地。
void	readProgram(int programId, java.lang.String filePath, BxFileReaderListener<Bx6GScreen> listener) 非同步方式读取控制器上的档案并保存在本地。
ProgramBxFileND	readProgram(java.lang.String programName) 同步方式读取控制器上的档案并保存在本地。
void	readProgram(java.lang.String programName, java.lang.String filePath, BxFileReaderListener<Bx6GScreen> listener) 非同步方式读取控制器上的档案并保存在本地。
java.util.List<java.lang.String>	readProgramList() 查询目前控制器上的节目清单。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	reset2Factory() 系统复位，复位后需重新加载屏幕参数。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	sensorBrightness() 修改传感器自動調整亮度。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	sensorBrightness(Bx6GBrightnessSensorEnv env) 修改传感器根據客制化传感器調整亮度。
void	setAliasName(java.lang.String aliasName) 设定屏幕名称。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	setupTimingOnOff(ScreenTimingOnOffCmd cmd) 设定定时开关机。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	switch2ClientMode(onbon.bx06.message.tcp.EthernetSetIP.StaticSetting staticSetting) 切换至一般网路模式，执行成功后，会将当前连线切断。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	switch2ServerMode(onbon.bx06.message.tcp.EthernetSetIP.StaticSetting staticSetting, onbon.bx06.message.tcp.EthernetSetIP.ServerSetting serverSetting) 切换至服務器模式，执行成功后，会将当前连线切断。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	syncTime() 校正系统时钟。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	turnOff() 强制关闭屏幕。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	turnOn() 强制开启屏幕。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	unlock() 解除锁定屏幕。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	unlockProgram(int programId) 解除锁定节目。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	unlockProgram(java.lang.String programName) 解除锁定节目。
boolean	writeConfig(ControllerConfigBxFile ccf) 同步方式将屏幕参数写入控制器。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	writeControllerAddress(byte[] addr) 更新控制器位址，此位址用於標示控制器，不等同於 TCP 位址(xxx.xxx.xxx.xxx)。
Bx6GScreen.Result<onbon.bx06.message.global.ACK>	writeDynamic(DynamicBxAreaRule rule, DynamicBxArea area) 更新动态区。
void	writeProgram(ProgramBxFile pf) 同步方式将节目写入控制器。
void	writeProgramAsync(ProgramBxFile pf, BxFileWriterListener<Bx6GScreen> listener) 非同步方式将特定节目写入控制器。
void	writeProgramQuickly(ProgramBxFile pf) 同步方式将节目写入控制器，本方法不做任何检查。
void	writePrograms(java.util.List<ProgramBxFile> pfs) 同步方式将节目写入控制器。
void	writeProgramsAsync(java.util.List<ProgramBxFile> pfs, BxFileWriterListener<Bx6GScreen> listener) 非同步方式将节目写入控制器。
void	writeProgramsQuickly(java.util.List<ProgramBxFile> pfs) 同步方式将节目写入控制器，本方法不做任何检查。

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

cancelTimingOnOff

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> cancelTimingOnOff()

取消定时开关机。

Returns:

执行结果。

changeOutputBuffer

public void changeOutputBuffer(int bufferSize)

改变输出缓存大小。有效范围 512Bytes ~ 64KB。
注意：改变缓存大小前请确认控制卡可接受上限，超过会造成控制卡运作失败。

Parameters:

bufferSize - 缓存大小。

checkControllerStatus

public Bx6GScreen.Result<onbon.bx06.message.led.ReturnControllerStatus> checkControllerStatus()

查询控制器状态。

Returns:

执行结果。

checkFirmware

public Bx6GScreen.Result<onbon.bx06.message.led.ReturnCurrentFirmwareStatus> checkFirmware()

查询当前固件状态。

Returns:

执行结果。

checkFirmware

public Bx6GScreen.Result<onbon.bx06.message.led.ReturnCurrentFirmwareStatus> checkFirmware(java.lang.String firmwareName)

查询当前固件状态。

Parameters:

firmwareName - 固件名称。

Returns:

执行结果。

checkHealth

public Bx6GScreen.Result<onbon.bx06.message.tcp.ReturnHealth> checkHealth()

读取网路设定，只适用于一般网路模式，当控制器为服务器模式时，回报为 NULL。

Returns:

网路设定。

checkMemVolumes

public Bx6GScreen.Result<onbon.bx06.message.ofs.ReturnMemVolume> checkMemVolumes()

查询文件系统容量。

Returns:

执行结果。

clockBrightness

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> clockBrightness(Bx6GBrightnessClockEnv env)

修改根據時間調整亮度。

Parameters:

env - 時間條間。

Returns:

执行结果。

createTimingOnOff

public ScreenTimingOnOffCmd createTimingOnOff()

建立定时开关机。设定定时开关机区间后执行 setupTimingOnOff 将结果传送至控制器。

Returns:

定时开关机。

See Also:

setupTimingOnOff

deleteAllDynamic

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> deleteAllDynamic()

删除所有动态区。

Returns:

执行结果。

deleteDynamic

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> deleteDynamic(int... dynamicIds)

删除动态区。

Parameters:

dynamicIds - 动态区号。

Returns:

执行结果。

deleteProgram

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> deleteProgram(int programId)

删除控制器上的特定节目。

Parameters:

programId - 节目编号，0-999。

Returns:

执行结果。

deleteProgram

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> deleteProgram(java.lang.String programName)

删除控制器上的特定节目。

Parameters:

programName - 节目名称。

Returns:

执行结果。

deletePrograms

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> deletePrograms()

删除控制器上所有的节目。

Returns:

执行结果。

deletePrograms

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> deletePrograms(int... programIds)

删除控制器上的特定节目组。

Parameters:

programIds - 节目编号组，0-999。

Returns:

执行结果。

deletePrograms

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> deletePrograms(java.util.List<java.lang.String> programNames)

删除控制器上的特定节目组。

Parameters:

programNames - 节目名称组。

Returns:

执行结果。

disconnect

public void disconnect()

断线。

getAliasName

public java.lang.String getAliasName()

取得屏幕名称。

Returns:

屏幕名称。

getControllerAddress

public java.lang.String getControllerAddress()

取得控制器位址。

Returns:

控制器位址。

getControllerType

public java.lang.String getControllerType()

取得控制器类型。

Returns:

控制器类型。

getId

public java.lang.String getId()

取得识别编号。

Returns:

识别编号。

getNetId

public abstract java.lang.String getNetId()

取得 Net 编号，ONBON 內部唯一識別碼。
1. GPRS 模式时表示短信中的 GPRS 编号。
2. Server 模式时表示控制器编号。

Returns:

Net 编号。

getProfile

public Bx6GScreenProfile getProfile()

取得当前屏幕规格。屏幕规格在连线成功后自动从控制器上获取，若控制器未加载屏参时回复 NULL。

Returns:

屏幕规格。

getRunMode

public Bx6GController.RunMode getRunMode()

取得运行模式。

Returns:

运行模式。

isConnected

public boolean isConnected()

是否已经连线。

Returns:

连线与否。

lock

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> lock()

锁定屏幕。

Returns:

执行结果。

lockProgram

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> lockProgram(int programId,
                                                           int lockDuration)

锁定节目。

Parameters:

programId - 节目编号，0-999。

lockDuration - 锁定秒数。

Returns:

执行结果。

lockProgram

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> lockProgram(int programId,
                                                           int lockDuration,
                                                           byte nonvolatile)

锁定节目。

Parameters:

programId - 节目编号，0-999。

lockDuration - 锁定秒数。

nonvolatile - 掉電保存方式。0x00:掉電不保存, 0x01:掉電保存。

Returns:

执行结果。

lockProgram

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> lockProgram(java.lang.String programName,
                                                           int lockDuration)

锁定节目。

Parameters:

programName - 节目名称。

lockDuration - 锁定秒数。

Returns:

执行结果。

lockProgram

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> lockProgram(java.lang.String programName,
                                                           int lockDuration,
                                                           byte nonvolatile)

锁定节目。

Parameters:

programName - 节目名称。

lockDuration - 锁定秒数。

nonvolatile - 掉電保存方式。0x00:掉電不保存, 0x01:掉電保存。

Returns:

执行结果。

manualBrightness

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> manualBrightness(byte level)

修改亮度。亮度值 1 ~ 16。

Parameters:

level - 亮度。

Returns:

执行结果。

ping

public Bx6GScreen.Result<onbon.bx06.message.led.ReturnPingStatus> ping()

Ping 控制器。

Returns:

执行结果。

readBarCode

public Bx6GScreen.Result<onbon.bx06.message.led.ReturnReadBarCode> readBarCode()

读取 Bar Code。

Returns:

读取 Bar Code。

readConfig

public onbon.bx06.message.file.ControllerConfigFile readConfig()
                                                        throws Bx6GException

同步方式读取控制器上的屏幕参数。

Returns:

屏幕参数。

Throws:

Bx6GException - 读取发生错误。

readControllerId

public Bx6GScreen.Result<onbon.bx06.message.led.ReturnControllerID> readControllerId()

读取控制器编号。

Returns:

执行结果。

readProgram

public ProgramBxFileND readProgram(int programId)
                            throws Bx6GException,
                                   uia.message.codec.BlockCodecException

同步方式读取控制器上的档案并保存在本地。

Parameters:

programId - 节目编号，0-999。

Returns:

节目。

Throws:

Bx6GException - 读取发生错误。

uia.message.codec.BlockCodecException - 解碼訊息错误。

readProgram

public void readProgram(int programId,
               java.lang.String filePath,
               BxFileReaderListener<Bx6GScreen> listener)

非同步方式读取控制器上的档案并保存在本地。

Parameters:

programId - 节目编号，0-999。

filePath - 储存档案。

listener - 读取监听器。

readProgram

public ProgramBxFileND readProgram(java.lang.String programName)
                            throws Bx6GException,
                                   uia.message.codec.BlockCodecException

同步方式读取控制器上的档案并保存在本地。

Parameters:

programName - 节目名称。

Returns:

节目。

Throws:

Bx6GException - 读取发生错误。

uia.message.codec.BlockCodecException - 解碼訊息错误。

readProgram

public void readProgram(java.lang.String programName,
               java.lang.String filePath,
               BxFileReaderListener<Bx6GScreen> listener)

非同步方式读取控制器上的档案并保存在本地。

Parameters:

programName - 节目名称。

filePath - 储存档案。

listener - 读取监听器。

readProgramList

public java.util.List<java.lang.String> readProgramList()
                                                 throws Bx6GCommException

查询目前控制器上的节目清单。

Returns:

节目清单。

Throws:

Bx6GCommException - 通讯异常。

reset2Factory

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> reset2Factory()

系统复位，复位后需重新加载屏幕参数。

Returns:

执行结果。

sensorBrightness

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> sensorBrightness()

修改传感器自動調整亮度。

Returns:

执行结果。

sensorBrightness

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> sensorBrightness(Bx6GBrightnessSensorEnv env)

修改传感器根據客制化传感器調整亮度。

Parameters:

env - 客制化传感器亮度條件。

Returns:

执行结果。

setAliasName

public void setAliasName(java.lang.String aliasName)

设定屏幕名称。

Parameters:

aliasName - 屏幕名称。

setupTimingOnOff

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> setupTimingOnOff(ScreenTimingOnOffCmd cmd)

设定定时开关机。

Parameters:

cmd - 定时开关机，利用 createTimingOnOff 方法产生並设定定时开关机区间。

Returns:

执行结果。

See Also:

createTimingOnOff

switch2ClientMode

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> switch2ClientMode(onbon.bx06.message.tcp.EthernetSetIP.StaticSetting staticSetting)

切换至一般网路模式，执行成功后，会将当前连线切断。

Parameters:

staticSetting - 网路位址设置。

Returns:

执行结果。

See Also:

网路位址程式

switch2ServerMode

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> switch2ServerMode(onbon.bx06.message.tcp.EthernetSetIP.StaticSetting staticSetting,
                                                                 onbon.bx06.message.tcp.EthernetSetIP.ServerSetting serverSetting)

切换至服務器模式，执行成功后，会将当前连线切断。

Parameters:

staticSetting - 网路位址设置。

serverSetting - 服務器应用程式设置。

Returns:

执行结果。

See Also:

网路位址程式

syncTime

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> syncTime()

校正系统时钟。

Returns:

执行结果。

turnOff

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> turnOff()

强制关闭屏幕。

Returns:

执行结果。

turnOn

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> turnOn()

强制开启屏幕。

Returns:

执行结果。

unlock

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> unlock()

解除锁定屏幕。

Returns:

执行结果。

unlockProgram

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> unlockProgram(int programId)

解除锁定节目。

Parameters:

programId - 节目编号，0-999。

Returns:

执行结果。

unlockProgram

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> unlockProgram(java.lang.String programName)

解除锁定节目。

Parameters:

programName - 节目名称。

Returns:

执行结果。

writeConfig

public boolean writeConfig(ControllerConfigBxFile ccf)
                    throws Bx6GException

同步方式将屏幕参数写入控制器。

Parameters:

ccf - 屏幕参数。

Returns:

下载结果。

Throws:

Bx6GException - 下载发生错误。

writeControllerAddress

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> writeControllerAddress(byte[] addr)

更新控制器位址，此位址用於標示控制器，不等同於 TCP 位址(xxx.xxx.xxx.xxx)。

Parameters:

addr - 控制器位址，2 bytes。

Returns:

执行结果。

See Also:

setAddress

writeDynamic

public Bx6GScreen.Result<onbon.bx06.message.global.ACK> writeDynamic(DynamicBxAreaRule rule,
                                                            DynamicBxArea area)

更新动态区。

Parameters:

rule - 动态区播放方式。

area - 动态区。

Returns:

执行结果。

writeProgram

public void writeProgram(ProgramBxFile pf)
                  throws Bx6GCommException,
                         Bx6GException

同步方式将节目写入控制器。

Parameters:

pf - 节目。

Throws:

Bx6GException - 下载发生错误。

Bx6GCommException - 通讯异常。

writeProgramAsync

public void writeProgramAsync(ProgramBxFile pf,
                     BxFileWriterListener<Bx6GScreen> listener)

非同步方式将特定节目写入控制器。

Parameters:

pf - 节目。

listener - 写入进度监听器。

writeProgramQuickly

public void writeProgramQuickly(ProgramBxFile pf)
                         throws Bx6GCommException,
                                Bx6GException

同步方式将节目写入控制器，本方法不做任何检查。

Parameters:

pf - 节目。

Throws:

Bx6GException - 下载发生错误。

Bx6GCommException - 通讯异常。

writePrograms

public void writePrograms(java.util.List<ProgramBxFile> pfs)
                   throws Bx6GCommException,
                          Bx6GException

同步方式将节目写入控制器。

Parameters:

pfs - 节目组。

Throws:

Bx6GException - 下载发生错误。

Bx6GCommException - 通讯异常。

writeProgramsAsync

public void writeProgramsAsync(java.util.List<ProgramBxFile> pfs,
                      BxFileWriterListener<Bx6GScreen> listener)

非同步方式将节目写入控制器。

Parameters:

pfs - 节目组。

listener - 写入进度监听器。

writeProgramsQuickly

public void writeProgramsQuickly(java.util.List<ProgramBxFile> pfs)
                          throws Bx6GCommException,
                                 Bx6GException

同步方式将节目写入控制器，本方法不做任何检查。

Parameters:

pfs - 节目组。

Throws:

Bx6GException - 下载发生错误。

Bx6GCommException - 通讯异常。