FreeIOE开发文档
  • Introduction
  • 基础介绍
    • FreeIOE是什么
    • 名词解释
  • 开发引导
    • 开发入门
    • 环境搭建
      • 使用网关产品
      • 使用虚拟网关
      • 使用VSCode插件开发
      • 其他应用开发方式
    • 应用开发
      • 应用是什么
      • 快速构建应用
        • 数据采集
        • 数据上云
        • 边缘计算
        • 设备通讯
      • 深入理解应用
        • 应用本质
        • 从零构造
        • 应用配置可视化
      • 注意事项
      • 应用示例
    • 发布应用
      • 申请账户
      • 新建应用
      • 克隆应用
      • 应用打包
      • 应用上传
  • 接口文档
    • 应用接口
      • 应用基础类模块
        • 应用基础类
        • MQTT应用基础类
      • 系统接口
      • 基础接口
      • 设备对象
      • 统计接口
      • 日志接口
      • 事件类型和等级
      • 云配置接口
      • 云配置帮助接口
      • 数据通讯模块
        • 端口模块
        • 帮助模块
        • 端口超时封装
      • 工具类模块
        • 数据订阅计算
        • 数据拼接
        • 数据流缓存
    • 系统服务接口
      • 配置服务
      • 软件分发服务
      • 扩展管理服务
      • 应用管理服务
      • 缓存服务
    • 其它资料 & 文档
      • Lua语言学习
      • 二进制数据操作
      • 文件操作
      • 模块列表
      • IOE模块
      • 串口操作模块
      • 累计量计算模块
      • 工具模块
        • helper模块
        • leds模块
        • gpios模块
        • sysinfo模块
        • 周期计时模块
Powered by GitBook
On this page
  • 累计量计算模块
  • new
  • add
  • set
  • get
  • reset
  • set_reset_cb
  • save

Was this helpful?

  1. 接口文档
  2. 其它资料 & 文档

累计量计算模块

累计量计算模块

API_VER: 6

用以计算周期内累计量,使用文件进行存储。且处理当数值重置时进行累加,而不是使用重置后的数值。

例如,通过获取网卡的当前收发字节数,来统计一天的字节数,当网卡被重启、系统重启后能继续累加字节数。且当零点时重置计数。

new

初始化模块对象

function summation:new(opt)
end

opt包含以下参数: | --- | --- | --- | | file | boolean | 是否使用文件存储(不使用文件存储,则系统重启计数会丢失) | | span | string | 计数的周期,可用周期: year, month, day, hour, minute | | save_span | number | 文件保存周期(秒),建议使用 60 * 5。太短的文件保存周期会导致过度使用设备存储,伤害存储寿命。 | | key | string | 系统内独立的统计名称,建议使用应用实例名 + 基数简称 | | path | string | 可选,文件保存路径,建议使用sysinfo.data_dir()获取地址 | | on_reset | function | 可选,当计数周期完毕,重置累计量前,会回调次函数 |

add

累加计数,会在当前的累计数值上加上参数value的数值。 key 是累计属性,即本对象支持多个累计属性。(当然所有累计属性使用同一个计数周期)

function summation:add(key, value)
end

set

设定当前获取的累计值,如果当前累计值小于之前传入的累计值,则会认为累计值已被重置,会在之前的累计值的基础上加上当前的累计值。

例如。上一次调用的值为10000,而本次调用为100时,调用get出来的累计值会是 10100

function summation:set(key, value)
end

get

获取统计出来的累计值

function summation:get(key)
end

reset

重置所有累计数值。

function summation:reset()
end

set_reset_cb

设定on_reset回调函数,同new函数的opt中的on_reset函数 (如果opt中有on_reset函数,会使用callback替换opt中的on_reset)

function summation:set_reset_cb(callback)
end

save

保存数据,当您的应用被停止时,建议调用一次本函数进行数据保存。避免保存周期还未执行导致的新增的计数丢失。

function summation:save()
end
Previous串口操作模块Next工具模块

Last updated 5 years ago

Was this helpful?