本文档描述魔豆路由器的应用程序开发规范。供开发者在开发适用于魔豆路由器的扩展应用程序时参考适用。
魔豆路由器的扩展应用程序是指：可以在魔豆路由器上运行的，独立的，可以通过魔豆路由器应用程序框架接口进行操作的软件包。
对软件包的操作包括：云端安装，本地上传安装，启动，停止，卸载，查询状态，配置。
软件包的内容可以包括：对应魔豆路由器芯片型号的二进制可执行程序，shell/lua语言的脚本，文本文件，图片、字体等资源文件， 或本用程序可以自行处理的其他文件格式。
- 应用程序最终发布包的根目录下应包含以下目录树中的文件，文件名区分大小写
./___
|--init
|--manifest.json
|--conf/
|--data.json // 应用的配置数据文件
|--actions.json // 应用支持的命令操作
|--tp_views.json // 屏幕上应用的视图定义文件
|--mobile_views.json // 手机路由宝应用中，本应用的视图定义文件
|--web_views.json // 浏览器中本应用的视图定义文件(暂不支持)
|--data/ // 应用运行时产生的目录，用户数据目录，用于保存用户数据，应用升级时，不会被删除
init必须接受以下命令。
start : 启动，实现启动本应用的操作
stop : 停止， 停止本应用的操作
status : 查询状态，查询本应用的状态
set_config : 对本应用重新进行配置，生效配置数据应该进行的操作
install : 安装，本应用安装后的一次性操作
uninstall : 卸载，本应用被卸载前的一次性操作
-
manifest.json文件包含本APP的ID和相关信息, 相关字段参见下文样例：package_id和name都是必填项且唯一的。
{
"package_id" : "com.1234.app-backlight", // 应用ID, 可选，会被系统替代成”com.” + author_forum_id + “.” + name
"name" : "app-backlight", // 应用的名字, 必填，且必须与库名一致，必须全小写字母，“app-”开头，仅支持 [0-9a-z\-\_]
"display_name" : "欢迎页面", // 应用的显示名称。可选，TP 程序可以用它显示；如果没有设置，默认使用 name 进行显示
"author" : "魔豆开发团队", // 应用作者的名字。可选，会被系统自动替代成论坛用户名
"author_forum_id" : "1234", //应用作者的论坛id。必填
"author_mail" : "rd@mochui.net", // 应用作者联系邮箱。必填
"homepage" : "www.modouwifi.com", // 应用相关的网页。可选
"version" : "0.1", // 当前应用版本。必填
"os_version" : "0.5.28", // 依赖的系统版本。必填
"release_date" : "2014.08.08", // 应用发布日期。必填
"icon" : "./res/icon_111X111.png", // 图标文件。必填，在 TP 上可以用它显示
"icon_url" : "http://xxx.icon", // 图标文件。可选，在 Web、Mobile 各端显示用
"location" : "internal", // 安装到的存储位置。必填。(internal: 路由器内部存储, external: USB外部存储, both: 两者皆可)
"description" : "这是一个样例", // 应用的描述。可选
"instruction" : "1.xxxx; 2.xxxxx", // 应用的安装或使用步骤指引。可选
"autostart" : false, // 应用安装后立刻启动。可选，true/false，默认是false
"start_on_boot" : false //路由器重启后，应用自动开启。可选，true/false，默认是false
}data.json描述本应用暴露出来可以进行配置修改的数据，样例如下：
{
"data1" : {
"id" : "data1", // 配置数据的ID
"name" : "username", // 配置数据的名字
"value" : "middle", // 配置数据的值
"group_id": "group1", // 配置数据的组ID
"type" : {
"class" : "ENUM|BOOL|INT|STRING|FLOAT|SET",
"items" : ["high", "middle", "low"], // ENUM，SET适用
"min" : 0, // INT, FLOAT, STRING使用
"max" : 100, // INT, FLOAT, STRING使用
"multiple" : true|false
}
}
}actions.json描述本应用支持或封装的命令，可供前端进行调用。样例如下：
{
"command1" : {
"id" : "command1", // 应用的命令ID
"is_sync" : true, // 是否需要同步阻塞执行,默认阻塞同步
"input" : "100", // 应用的命令参数
"cmd" : "./sbin/run_priv_cmd1", // 应用的命令
"relative": true, // 应用的命令适用的是相对路径
"private" : true // 改命令对外不支持调用；没有`private`字段，默认为`public`
},
"command2" : {
"id" : "command2",
"is_sync" : true,
"input" : "",
"cmd" : "/bin/reboot",
"relative": false
}
}*_views.json描述在屏幕、路由宝、浏览器中本应用所展示的视图，样例如下：
mobile_views.json
{
"view1" : {
"id" : "view1", // 配置视图的ID
"name" : "viewname", // 配置视图的名字
"data" : {
"data1" : {"id" : "data1",// 视图需要展示的数据的ID
"acess" : "RO|RW" // 数据是否可修改
},
...
},
"menu" : { // 主视图适用
"1" : { "index" : 1,
"text" : "contract",
"type" : "COMMAND|MENU|VIEW",
"action" : actionid, // COMMAND适用
"input" : data1, // COMMAND适用
"viewid" : viewid, // VIEW适用
"items" : { // MENU适用
"1" : {
"index" : 1,
"text" : "item1",
"type" : "COMMAND|VIEW",
"action" : actionid, // COMMAND适用
"input" : data1, // COMMAND适用
"viewid" : viewid // VIEW适用
},
...
}
},
...
}
}
}应用的版本号必须符合 语义化版本2.0.0 规范
魔豆上的高级 DNS
魔豆上的 Samba 文件共享
Launcher 程序读取配置文件，显示 App Icon, 并且在用户点击 Icon 时执行命令。
以 JSON 配置格式，每个文件对应一个程序。
{
"name" : "AppName",
"icon" : "/path/icon.png",
"iconPressed" : "/patb/icon_p.png",
"exec" : "/path/app",
"msgNum" : 4
} 1) 必须有 .conf 后缀.
2) 尽量以程序名字+.conf 作为文件名，避免与其他程序的配置文件冲突。
配置文件放在 /data/conf/launcher/conf.d 目录。
从这个目录删除配置文件，Launcher不再显示相应的图标。
111 × 111
不符合规格的图片显示不了。
语法 : appInfo.sh < get_status <package_id> | set_status <package_id> <ISRUNNING | NOTRUNNING> >
| 参数 | 参数名 | 意义 |
|---|---|---|
| get_status, set_status | 命令 | |
| <package_id> | 应用程序的包ID | |
| ISRUNNING, NOTRUNNING | 正在运行, 不在运行 |
| 命令 | 退出码 | 输出 | 意义 |
|---|---|---|---|
| get_status | 0 | ISRUNNING | 该应用正在运行 |
| 1 | NOTRUNNING | 该应用不在运行 | |
| 2 | NOTFOUND | 应用不存在或未找到 | |
| 3 | PARAMETER MISSING | 缺少参数 | |
| set_status | 0 | OK | 设置成功 |
| 1 | ERROR | 设置失败 | |
| 2 | PARAMETER MISSING | 缺少参数 |