node-red-contrib-presence-faker/pf.js

Simulates home occupancy by intermittently activating and deactivating devices (e.g. lights) at random intervals

const dayjs = require('dayjs')
let debug = (msg) => null

function randomInt(min, max) {
  return Math.floor(Math.random() * max) + min
}

function setDebugFn(debugFn) {
  debug = debugFn
}

function createSchedule({
  windowBegin,
  windowEnd,
  minDuration,
  maxDuration,
  minCount,
  maxCount,
  firstBlockType,
  lastBlockType,
}) {
  const now = dayjs()

  windowBegin = dayjs(now.format('YYYY-MM-DD') + 'T' + windowBegin)
  windowEnd = dayjs(now.format('YYYY-MM-DD') + 'T' + windowEnd)

  let windowDuration = windowEnd.diff(windowBegin, 'seconds')

  // handle special case of windowBegin > windowEnd, i.e. windows spanning two days
  if (windowDuration < 0) {
    windowDuration = 60 * 60 * 24 + windowDuration

    if (now.isBefore(windowEnd)) {
      windowBegin = windowBegin.subtract(1, 'day')
    }
  }

  const calcRandomDuration = () =>
    randomInt(Number(minDuration), Number(maxDuration))

  const calcRandomCount = () =>
    calcRandomNumber(Number(minCount), Number(maxCount))

  const calcRandomNumber = (min, max) => randomInt(min, max)

  const sumDurations = (blocks) =>
    blocks.reduce((prev, curr) => prev + curr.duration, 0)

  const randomCount = calcRandomCount()

  const onBlocks = []
  const offBlocks = []

  for (let i = 1; i <= randomCount; i++) {
    onBlocks.push({
      isOn: true,
      duration: calcRandomDuration(),
    })
  }

  // remove as many on-blocks as needed to fit the time window
  while (sumDurations(onBlocks) >= windowDuration) {
    onBlocks.shift()
  }

  // add one block if none was left:
  if (randomCount > 0 && onBlocks.length == 0) {
    onBlocks.push({
      isOn: true,
      duration: Math.floor(windowDuration * 0.9), // spans 90% of the window
    })
  }

  let sumOnDurations = sumDurations(onBlocks)

  // how much time is left for OFF blocks?
  let sumOffDurations = windowDuration - sumOnDurations

  const offBlockCount =
    onBlocks.length +
    (firstBlockType === 'off' ? 1 : 0) +
    (lastBlockType === 'off' ? 0 : -1)

  for (let i = 0; i < offBlockCount; i++) {
    offBlocks.push({
      isOn: false,
      random: calcRandomNumber(1, 10),
    })
  }

  const sumOfRandom = offBlocks.reduce((acc, curr) => acc + curr.random, 0)

  offBlocks.map((block) => {
    const factor = block.random / sumOfRandom
    block.duration = Math.floor(sumOffDurations * factor)
    delete block.random
  })

  //do off-durations match sumOffDurations?
  const diff = sumOffDurations - sumDurations(offBlocks)

  //apply diff to 1st off-block (if it exists)
  if (offBlocks[0]) {
    offBlocks[0].duration += diff
  }

  let schedule = _combineBlocks(offBlocks, onBlocks, firstBlockType)
  //console.log(schedule)
  return _calcScheduleTimes(schedule, windowBegin)
}

function _combineBlocks(offBlocks, onBlocks, firstBlockType) {
  let schedule = []

  const greenBlocks = firstBlockType === 'off' ? offBlocks : onBlocks
  const blueBlocks = firstBlockType === 'off' ? onBlocks : offBlocks

  const iterations = Math.max(greenBlocks.length, blueBlocks.length)

  for (let i = 0; i < iterations; i++) {
    if (greenBlocks[i]) {
      schedule.push(greenBlocks[i])
    }

    if (blueBlocks[i]) {
      schedule.push(blueBlocks[i])
    }
  }

  return schedule
}

function _calcScheduleTimes(schedule, start) {
  schedule.forEach((block) => {
    block.beginString = start.format('HH:mm:ss')
    let end = start.add(block.duration, 'second')
    block.endString = end.format('HH:mm:ss')
    block.begin = start
    start = end
  })

  return schedule
}

function stripPastBlocks(blocks) {
  const now = dayjs()
  return blocks.filter((block) => {
    let end = block.begin.add(block.duration, 'second')
    return now.isBefore(end)
  })
}

module.exports = { createSchedule, stripPastBlocks, setDebugFn }