泛联灯控系统dll说明文档v1.0

泛联灯控系统 dll 说明文档 v1.0
CJY 20180118 内部预览版本
灯控分组类
类名称：SLSGroupEntity 参数集： { int GroupAddress, string groupAlias, List<int> lights, }
自定义参数：设备通讯短地址
只读,不可配置。继承于 ParamBase。 类名称：Param5_Address 参数集： { int ParamID=5; // 参数 ID int Address; // 设备通讯短地址 }
自定义参数：心跳包周期
可读取,可配置。继承于 ParamBase。 类名称：Param6_ HeartBitSpan 参数集： { int ParamID=6; // 参数 ID int HeartBitSpan; // 心跳包周期 }
自定义参数：设备 IEEE 地址
只读,不可配置。继承于 ParamBase。 类名称：Param4_IEEEAddress 参数集： { int ParamID=4; string IEEEAddress_String; } 格式说明：8 个十六进制数， “‐”连接
// 参数 ID // 设备 IEEE 地址
自定义参数：单色 LED
可读取,部分参数内容可配置。继承于 ParamBase。
类名称：Param7_LEDWrokingState 参数集： { int ParamID=7 // 参数 ID
SLSLightWrokingState LightWrokingState; // 工作模式定义（可写，固定亮度模式 0，自动控制模式 1） int LightBrightness; //灯的亮度（在固定亮度模式下可写） int MotionBrightness; // 探测到有人经过时的灯亮度(在自动控制模式下可写） int NoMotionBrightness; // 未探测到人时的灯亮度(在自动控制模式下可写） int LightDelayTime; // 亮灯延时(在自动控制模式下可写 单位为秒，范围为 8~65535）
补充接口 1
接口名称：SLS_ControlLightList 接口功能说明：远程实时控制（调节灯控制器亮度） 接口参数： 输入： 参数名称 FeatureString AddressType AddressList IsUserControl LightBrightness 输出： 参数名称 ReturnResult 参数类型 Int 参数说明 返回结果 参数类型 String Int List<int> bool Int 参数说明 网关 MAC 地址 地址类型（0：组地址，1： 节点地址） 地址集合 实时控制开关（true:手动控 制，false:自动控制） 实时亮度
参数说明：服务器状态 负数为异常，后期可添加更多状态异常码
接口消息 1
消息名称：Msg_LightError 消息功能说明：灯控制器异常报出 接口参数： 输入：无 输出： 参数名称 Address ErrorMsg 参数类型 Int String 参数说明 灯控制器短地址 异常信息
} 说明：灯亮度 0 表示关灯，1‐10 表示亮度 10%~100%。
自定义参数：传感器参数
可读取,部分参数内容可配置。继承于 ParamBase。 类名称：Param8_ SensorInfo 参数集： { int ParamID=8 // 参数 ID bool IsUsing; // 传感器使能开关 （可读写， true 表示使用此传感器， false 表示不使用）
接口 4
接口名称：SLS_LightConfig 接口功能说明：配置灯控制器参数（基础参数、传感器灵敏度、亮灯延时等） 接口参数：
输入： 参数名称 FeatureString Address Params 输出： 参数名称 ReturnResult 参数类型 bool 参数说明 返回发送成功与否 参数类型 String int List<ParamBase> 参数说明 网关 MAC 地址 灯控制器短地址 参数集合
自定义参数：设备类型
只读,不可配置。继承于 ParamBase。 类名称：Param3_DeviceType 参数集： { int ParamID=3; // 参数 ID
SLSDeviceType DeviceType; 通讯节点，3 灯通讯节点） }
// 设备类型（‐1 未知，0 网关控制器，2 网关
自定义参数：GIT SHA
只读,不可配置。继承于 ParamBase。 类名称：Param2_GIT_SHA 参数集： { int ParamID=2; // 参数 ID string GIT_SHA_String; // GIT SHA 参数值 } 格式说明：4 个十六进制数， “‐”连接
接口 3
接口名称：SLS_GetGatewayInfo_Plans 接口功能说明：获取网关信息 接口参数： 输入： 参数名称 FeatureString 输出： 参数名称 Plans 参数类型 List< SLSPlanEntity> 参数说明 返回网关灯控计划 参数类型 String 参数说明 网关 MAC 地址
接口 2
接口名称：SLS_GetGatewayInfo_Groups 接口功能说明：获取网关信息 接口参数： 输入： 参数名称 FeatureString 输出： 参数名称 Groups 参数类型 List<SLSGroupEntity> 参数说明 返回网关灯控制器分组 参数类型 String 参数说明 网关 MAC 地址
发送成功结果： 0~10 表示发送的控制亮度 发送异常结果： ‐1：未能成功发送 ‐2：sls 服务器未在正确的开启状态 ‐101：内部错误：出现异常 ‐102：内部错误：sls 服务器实力为空 ‐103：内部错误：sls 网关集合错误
自定义参数： 基础参数类
类名称：ParamBase 参数集： { int ParamID; }
接口 6
接口名称：SLS_NewVersionPush 接口功能说明：远程升级 接口参数：SLS_NewVersionPush 输入： 参数名称 FeatureString UpgradeFilePath 输出： 参数名称 ReturnResult 参数类型 bool 参数说明 返回配置成功与否 参数类型 String String 参数说明 网关 MAC 地址 升级文件路径
// 组地址 // 组名称 // 组内灯控制器（灯控制器短地址集合）
灯控计划类
类名称：SLSPlanEntity 参数集： { int planType, // 计划类型（0 周计划，1 特殊日计划） List<int> planGroups, // 对此计划生效的灯控分组集合 bool sundayWorking, // 周日生效（仅周计划） bool monday Working, // 周一生效（仅周计划） bool tuesday Working, // 周二生效（仅周计划） bool wednesday Working, // 周三生效（仅周计划） bool thursday Working, // 周四生效（仅周计划） bool friday Working, // 周五生效（仅周计划） bool satursday Working, // 周六生效（仅周计划） string planDay,// 计划生效日期（仅特殊日计划） string planTime,// 计划生效时间 Param7_LEDWrokingState planInfo,//计划执行内容 } 说明：Param7_LEDWrokingState 参数格式，参见“自定义参数”
接口 1
接口名称：SLS_GatewayConfig 接口功能说明：配置网关参数（基础参数、网关下的灯控制器分组信息、网关灯控计划信 息）
接口参数： 输入： 参数名称 FeatureString Groups Plans 输出： 参数名称 ReturnResult
参数类型 string List<SLSGroupEntity> List<SLSPlanEntity> 参数类型 bool 参数说明 网关 MAC 地址 配置参数网关灯控制器分组 配置参数网关灯控计划 参数说明 返回发送成功与否rver 接口功能说明：打开 SLS Server 接口参数： 输入： 参数名称 IP address PortNum 输出： 参数名称 ReturnResult 参数类型 bool 参数说明 返回打开成功与否 参数类型 String Int 参数说明 服务器 IP 地址 服务器端口号
接口 5
接口名称：SLS_GetLightInfo 接口功能说明：获取灯控制器信息 接口参数： 输入： 参数名称 FeatureString Address paramIDs 输出： 参数名称 params 参数类型 List<ParamBase> 参数说明 返回灯控制器信息 参数类型 String int List<int> 参数说明 网关 MAC 地址 灯控制器短地址 参数 ID 集合
// 参数 ID
自定义参数：软件版本（嵌入式程序）
只读,不可配置。继承于 ParamBase。 类名称：Param0_SoftwareVersion 参数集： { int ParamID = 0; // 参数 ID SLSFirmwareType DeviceType; // 固件类型(0 网关,1 手持机,2 灯节点) int Major; // 主版本号 int Minor; // 从版本号 }
SLSSensorType SensorType; // 传感器类型（只读，微波传感器 0，红外传感器 1， 无传感器类型信息 0） SLSSensorWorkingState SensorWorkingState;// 传感器工作状态（只读，没有检测 到人 0，检测到人 1，传感器电流异常 2，无状态信息 0）