统计

接口依赖云能力,需在小程序开发者平台开发设置-云能力进行授权配置。📢注意:统计能力使用需要提交工单开通产品数据统计,请在使用前 提交快速工单。

接口能力

对智能计量的能力我们提供了下接口能力,开发者可直接调用 API 完成计量相关业务开发。

注意,以下 API 需要在 @ray-js/ray^1.2.12 使用。

接口名描述
getStatisticsConfig获取统计数据的配置信息
getStatisticsRang15min15min 为时间间隔,获取设备日期区间的统计数据
exportStatistics15min15min 为时间间隔,导出设备指定日期的统计数据
getStatisticsRangHour小时为时间间隔,获取设备日期区间的统计数据
exportStatisticsHour小时为时间间隔,导出设备日期区间的统计数据
getStatisticsRangDay天为时间间隔,获取设备日期区间的统计数据
exportStatisticsDay天为时间间隔,导出设备日期区间的统计数据
getStatisticsRangMonth月为时间间隔,获取导出设备日期区间的统计数据
exportStatisticsMonth月为时间间隔,导出设备在过去一个月内的统计数据
resetStatistics重置设备的统计数据

图表组件

安装

npm install @ray-js/stat-charts

组件 Props

名称类型必填默认值描述
styleReact.CSSPropertiesN图表容器的样式
devIdListstring[]Y设备 id 列表, (暂不支持多个)
dpListDp[]YDP 功能点列表, 图表的数据维度, 格式 { name: string, id: number }
rangestringY数据合集, 时间单位内为一个点, 例如: 15min, 1hour, 1day, 1month
typestringNsum统计类型,详见 统计类型说明。例如: avg, max, min, sum, count
unitstringY数据单位, 例如: ℃, %, m
startDatestringY数据开始时间, 格式: YYYYMMDD, 例如: 202305 20230522
endDatestringO''数据结束时间, 数据合集为 1day 1month 需提供, 格式为 YYYYMMDD
renderTitle({ data }) => React.ReactNodeN''自定义图表标题
renderFooter({ data }) => React.ReactNodeN''自定义图表尾部
themestringNlight主题, 'light' / 'dark'
dataZoomnumberN0显示数据轴的百分比 1~100 -100~-1 之间, 默认为左侧, 负数表示显示数据的右侧
chartTypestringNline图表类型, line / bar / line-area
widthnumberN654图表宽度, 单位为 rpx
heightnumberN422图表高度, 单位为 rpx
placeholder{ loading: string; error: string; none: string }N{ loading: 'Loading...', error: 'Failed To Load', none: 'No data for this period…' }图表中央的占位文案,,根据 placeholderIcon 的状态来显示
placeholderIconstringNloading空数据时的占位图标, 可选值: loading, error, none
placeholderYAxisnumberN10空数据时 Y 轴的最大值, 0 则不展示 Y 轴
placeholderXAxisstring[]N['6:00', '12:00', '18:00']空数据时 X 轴的标签, [] 则不展示 X 轴
debugbooleanNfalse是否开启调试模式,开启后会生成随机数据,请勿在生产模式使用

使用示例

展示全年气温统计

import StatCharts from '@ray-js/stat-charts';

<StatCharts
  devIdList={['vdevo168473759041567']} // 设备 id
  dpList={[{ id: 27, name: '温度' }]} // 功能点 id 及 名称
  unit="℃" // 数据单位
  range="1month" // 以每个月为一个点
  type="avg" // 统计类型, 统计该月的平均值
  startDate="202301" // 数据开始时间 1月开始
  endDate="202312" // 数据结束时间 12月结束
  count={25} // 副标题上的数据
  chartType={'line'} // 折线图
/>;

统计设备能耗数据

<StatCharts
  devIdList={['vdevo168473759041567']}
  dpList={[
    { id: 27, name: '温控器' },
    { id: 28, name: '氛围灯' },
  ]}
  unit="kwH" // 单位 千瓦时
  range="15min" // 每 15 分钟为一个点
  startDate="20230522" // 统计当天的数据
  dataZoom={-30} // 可缩放滑动 默认展示数据的右侧 30%
  chartType="bar" // 柱状图
/>

关于图表类需求的统计接口中的 type 参数的解释

统计类型说明

下面的时间间隔目前写的都是1小时,可以换成支持的1天或1个月。

sum

把 1小时 内上报的数据进行 累加,得到该时段数据的 总和。适用于累计量(如用电量、用水量)。

minux

取 1小时 内上报数据的 最大值,减去 上个小时 上报数据的 最大值,得到该时段的 增量/用量。适用于表计、计数器类设备的时段用量(如电表、水表每时段用量)。

  • Tip: 如果 上个小时 没有数据,再之前的上报的最大数据相减,得到这个小时的使用数据。
  • Tip: 这个类型本应该是 minus, 因为一开始(三年前)的单词拼错了,所以现在就一直用 minux了。

avg

把 1小时 内上报的数据,进行 累加 操作,并除以上报的 次数,得到这个 小时数据的 平均值。适用于温度、湿度等需要看平均水平的指标。

min

统计 1小时 内上报的数据的最小值。适用于最低温度、最低电量、谷值功率等场景。

max

统计 1小时 内上报的数据的最大值。适用于最高温度、峰值功率、用电高峰等场景。

count

统计 1小时 内上报的数据的次数。适用于开关次数、上报频次、事件次数等场景。

recent

统计离 整点时间 最近的那个点,该类型仅支持按小时统计,不支持按天或按月。适用于需要对齐整点采样的曲线展示(如每小时一个点的折线图)。

统计间隔

按小时统计

简单说就是根据统计类型统计一个小时内上报的数据,然后聚合成一个点

按天获取

简单说就是根据统计类型统计一天内上报的数据,然后聚合成一个点

按月统计

简单说就是根据统计类型统计月内上报的数据,然后聚合成一个点