智能小程序 Ray 开发——生物节律 API 接口汇总

生物节律

该接口为云能力，需开通授权后使用，关于云能力可查看文档

接口能力

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

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

接口名	描述
createLightRhythmsRefreshTimer	创建定时刷新生物节律时间的任务
getLightRhythmsCityInfo	获取城市信息
getLightRhythmsTimeInfo	获取日出日落时间

 

createLightRhythmsRefreshTimer

该接口为云能力，需开通授权后使用，关于云能力可查看文档

需引入 MiniKit，且在 >= 3.7.6 版本方可使用

创建定时刷新生物节律时间的任务

使用 cron 时间，创建定时刷新生物节律（日出/日落/正午等）时间的云端任务。需要注意的是，使用该接口之前，需要在设备属性中保存生物节律信息，否则将会失败。

ℹ️ 生物节律 需要在 涂鸦开发者平台产品功能定义页面开通高级能力后方可使用，否则调用云能力会出现失败的情况

请求参数

参数名	类型	是否必填	说明
bizId	string	true	业务 ID
bizType	number	true	业务类型
cron	string	false	cron 表达式

返回参数

boolean

请求示例

// @ray-js/ray^1.4.14
import { createLightRhythmsRefreshTimer } from "@ray-js/ray";
 
createLightRhythmsRefreshTimer({
  bizId: "vdevo167504******003",
  bizType: 0,
  cron: "0 0 0 * * ?"
})
  .then((response) => {
    console.log(response);
  })
  .catch();

返回示例

true;
false;

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。 

getLightRhythmsTimeInfo

该接口为云能力，需开通授权后使用，关于云能力可查看文档

获取日出日落时间，并以设备或群组所在时区输出。

ℹ️  需要在 涂鸦开发者平台产品功能定义页面开通高级能力后方可使用，否则调用云能力会出现失败的情况

请求参数

参数名	类型	是否必填	说明
bizId	string	true	业务 ID
bizType	number	true	业务类型 0：设备 1：群组
lon	string	true	经度
lat	string	true	纬度

返回参数

TimeInfo[]

TimeInfo

参数名	类型	说明
date	string	日期，格式为 yyyyMMdd
sunrise	string	日出时间
sunset	string	日落时间
transitAtNoon	string	正午时间
dawn	string	日出前时间
dusk	string	日落后时间

请求示例

// @ray-js/ray^1.4.14
import { getLightRhythmsTimeInfo } from "@ray-js/ray";
 
getLightRhythmsTimeInfo({
  bizId: 'vdevo167504******003',
  bizType: 0,
  lon: '112.233',
  lat: '30.233'
})
  .then((response) => {
    console.log(response);
  })
  .catch();

返回示例

[
  {
    "date": "20231020",
    "sunrise": "22:35",
    "dusk": "10:25",
    "transitAtNoon": "04:15",
    "sunset": "09:55",
    "dawn": "22:05"
  }
]

 

getLightRhythmsCityInfo

该接口为云能力，需开通授权后使用，关于云能力可查看文档

获取指定地理位置所在的城市信息。

ℹ️ 生物节律 需要在 涂鸦开发者平台产品功能定义页面开通高级能力后方可使用，否则调用云能力会出现失败的情况

请求参数

参数名	类型	是否必填	说明
bizId	string	true	业务 ID
bizType	number	true	业务类型 0：设备 1：群组
lon	string	true	经度
lat	string	true	纬度

返回参数

参数名	类型	说明
country	string	国家
province	string	省份
city	string	城市

请求示例

// @ray-js/ray^1.4.14
import { getLightRhythmsCityInfo } from "@ray-js/ray";
 
getLightRhythmsCityInfo({
  bizId: 'vdevo167504******003',
  bizType: 0,
  lon: '112.233',
  lat: '30.233'
})
  .then((response) => {
    console.log(response);
  })
  .catch();

返回示例

{
  "country": "中国",
  "city": "益阳市",
  "province": "湖南省"
}

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。