dtalk(Device Talk)开发手册(更新中)

{
	"catalog": "MENU",
	"container": true,
	"description": "",
	"disable": false,
	"empty": false,
	"name": "facelog",
	"path": "/facelog",
	"uiName": "facelog \xe6\x9c\x8d\xe5\x8a\xa1\xe5\x99\xa8"
	"childs": 
	[
		{"catalog": "CMD","childs": [],"container": true,"description": "","disable": false,"empty": true,"name": "back","path": "/","taskQueue": null,		"uiName": "back"}, 
		{"catalog": "OPTION","childs": [],"container": false,"defaultValue": null,"description": "",	"disable": false,"empty": true,"name": "host","path": "/facelog/host","readOnly": false,"required": false,"type": "STRING","uiName": "\xe4\xb8\xbb\xe6\x9c\xba\xe5\x90\x8d\xe7\xa7\xb0","value": "localhost"},
		{"catalog": "OPTION","childs": [],"container": false,"defaultValue": 0,"description": "","disable": false,"empty": true,"name": "port","path": "/facelog/port","readOnly": false,"required": false,"type": "INTEGER","uiName": "\xe7\xab\xaf\xe5\x8f\xa3\xe5\x8f\xb7","value": 26411}
	],

}

{
	"mac": "58fb842d294f",/** 管理端自己的MAC地址 */
	"pwd": "33902b064aab3e1c0db64827d8496fce" /** 管理端提供的连接密码(已加密) */
}

	{"catalog":"MENU","name":"","path":"/","uiName":"","container":true,"description":"","disable":false,"empty":false,
	  	"childs":[
		  	{"catalog":"CMD","name":"quit","path":"/quit","childs":[],"container":true,"description":"","disable":false,"empty":true,"taskQueue":null,"uiName":"quit"},
		  	{"catalog":"MENU","name":"menu1","path":"/menu1","uiName":"菜单1","container":true,"description":"","disable":false,"empty":false,
			 	"childs":[
			  	{"catalog":"CMD","childs":[],"container":true,"description":"","disable":false,"empty":true,"name":"back","path":"/","taskQueue":null,"uiName":"back"},
			  	{"catalog":"MENU","name":"menu1_1","path":"/menu1/menu1_1","uiName":"菜单1.1",,"container":true,"description":"","disable":false,"empty":false
				 	"childs":[
				  		{"catalog":"CMD","name":"back","path":"/","taskQueue":null,"uiName":"back","childs":[],"container":true,"description":"","disable":false,"empty":true},
				  		{"catalog":"OPTION""name":"option1","uiName":"选项1","path":"/menu1/menu1_1/option1","childs":[],"container":false,"defaultValue":null,"description":"","disable":false,"empty":true,,"readOnly":false,"required":false,"type":"STRING","value":null},
				  		{"catalog":"OPTION","name":"option2","uiName":"选项2","path":"/menu1/menu1_1/option2","childs":[],"container":false,"defaultValue":0,"description":"","disable":false,"empty":true,"readOnly":false,"required":false,"type":"INTEGER","value":null}
					]}]},
		  	{"catalog":"MENU","container":true,"description":"","disable":false,"empty":false,"name":"menu2","path":"/menu2","uiName":"菜单2",
			 	"childs":[
				  	{"catalog":"CMD","name":"back","path":"/","uiName":"back","childs":[],"container":true,"description":"","disable":false,"empty":true,"taskQueue":null},
				  	{"catalog":"MENU","name":"menu2_1","path":"/menu2/menu2_1","uiName":"菜单2.1","container":true,"description":"","disable":false,"empty":false,
					 	"childs":[
						  	{"catalog":"CMD","name":"back","uiName":"back","path":"/","childs":[],"container":true,"description":"","disable":false,"empty":true,"taskQueue":null},
							{"catalog":"CMD","name":"cmd1","uiName":"命令1","path":"/menu2/menu2_1/cmd1","container":true,"description":"","disable":false,"empty":true,"taskQueue":null,
								"childs":[
									{"catalog": "OPTION","name": "param1","uiName": "命令参数1","path": "/menu2/menu2_1/cmd1/param1","childs": [],"container": false,"defaultValue": null,"description": "","disable": false,"empty": true,"readOnly": false,"required": false,"type": "STRING","value": null}
								]
							}
						]}]}
		]
	}

{"catalog":"MENU","path":"/"}

{"catalog":"OPTION","path":"/menu1/menu1_1/option1","value":"HELLO"}
#NOTE: 'catalog'字段可以省略

{"catalog":"CMD","path":"/menu2/menu2_1/cmd1" "childs":[{"name": "param1","value":"HELLO"}]}
#NOTE: 'catalog'字段可以省略

	OptionBuilder.builder(IntOption.class).name("status").readonly(true).value(0).instance().setValidator(new Predicate<Integer>() {
		
		@Override
		public boolean apply(Integer input) {
			return input != null && input > 100;
		}
	});

public void test6Menu(){
	MenuItem menu1 = ItemBuilder.builder(MenuItem.class).name("menu1").uiName("菜单1").addChilds(
			ItemBuilder.builder(MenuItem.class).name("menu1_1").uiName("菜单1.1").addChilds(
					OptionType.STRING.builder().name("option1").uiName("选项1").instance(),
					OptionType.INTEGER.builder().name("option2").uiName("选项2").instance()
					).instance()
			).instance();
	MenuItem menu2 = ItemBuilder.builder(MenuItem.class).name("menu2").uiName("菜单2").addChilds(
			ItemBuilder.builder(MenuItem.class).name("menu2_1").uiName("菜单2.1").addChilds(
						ItemBuilder.builder(CmdItem.class).name("cmd1").uiName("命令1").instance().addParameters(
								OptionType.STRING.builder().name("param1").uiName("命令参数1").instance()
								)
					).instance()
			).instance();
	RootMenu root = new RootMenu();
	root.addChilds(menu1,menu2);
	
	logger.info(BaseJsonEncoder.getEncoder().toJsonString(root));
}

/**
 * 设备命令执行接口
 * @author guyadong
 *
 */
public static interface ICmdImmediateAdapter {
	/**
	 * 执行设备命令
	 * @param input 以值对(key-value)形式提供的输入参数
	 * @return 命令返回值，没有返回值则返回{@code null}
	 * @throws CmdExecutionException 命令执行失败
	 */
	Object apply(Map<String, Object> input) throws CmdExecutionException;
}

/**
 * 执行立即命令
 * @return
 * @throws CmdExecutionException 设备命令执行异常
 */
public final Object runImmediateCmd() throws CmdExecutionException{
	checkState(cmdAdapter instanceof ICmdImmediateAdapter,"type of cmdAdapter must be %s",ICmdImmediateAdapter.class.getSimpleName());
	synchronized (items) {
		if(cmdAdapter !=null){
			try {
				// 将 parameter 转为 Map<String, Object>
				Map<String, Object> objParams = Maps.transformValues(items, TO_VALUE);
				return ((ICmdImmediateAdapter)cmdAdapter).apply(checkRequired(objParams));					
			} finally {
				reset();
			}
		}
		return null;
	}
}

/**
 * 交互设备命令接口
 * @author guyadong
 *
 */
public interface ICmdInteractiveAdapter extends ICmdUnionAdapter {
	/**
	 * 执行设备命令
	 * @param input 以值对(key-value)形式提供的输入参数
	 * @param listener 状态侦听器，用于向管理端发送命令状态
	 * @return 命令返回值，没有返回值则返回{@code null}
	 * @throws InteractiveCmdStartException 当设备命令被拒绝或不支持或其他出错时抛出此异常,通过{@link InteractiveCmdStartException#getStatus() }获取状态类型
	 */
	void apply(Map<String, Object> input,ICmdInteractiveStatusListener listener) throws InteractiveCmdStartException;
	/**
	 * 取消当前执行的设备命令
	 * @throws UnsupportedOperationException 设备命令不支持取消
	 */
	void cancel() throws UnsupportedOperationException;
}

/**
 * 命令状态侦听器，用于交互命令向管理端发送命令执行状态
 * @author guyadong
 */
public interface ICmdInteractiveStatusListener{
	/**
	 * 返回设备命令完成进度<br>
	 * 设备命令在执行过程中应该定时调用此方法，以作为心跳发送给管理端，直到任务结束
	 * @param progress 完成进度(0-100),可为{@code null}
	 * @param statusMessage 附加状态消息,可为{@code null}
	 */
	void onProgress(Integer progress,String statusMessage);
	/**
	 * 任务结束,设备命令成功执行完成
	 * @param value 命令执行返回值,没有返回值则为{@code null}
	 */
	void onFinished(Object value);
	/**
	 * 任务结束,执行中的设备命令被取消
	 */
	void onCaneled();
	/**
	 * 任务结束,调用抛出异常
	 * @param errorMessage 错误信息，可为{@code null}
	 * @param throwable 异常对象，可为{@code null}
	 */
	void onError(String errorMessage, Throwable throwable);
	/**
	 * 此方法用于设备命令发送方控制设备端定时报告进度的间隔(秒)，
	 * 设备端调用此方法获取数值后，用于控制调用{@link #onProgress(Integer, String)}方法的调用间隔
	 * @return 返回要求的{@link #onProgress(Integer, String)}方法调用间隔(秒)，<=0时，使用设备自定义的默认值
	 */
	int getProgressInternal();
}