feat(cli): add weather scenario

cli/src/scenarios/weather.ts

@@ -0,0 +1,96 @@
+import { Faker } from '@faker-js/faker'
+
+const dataCache: Record<string, any> = {}
+
+function getCurrentSeason() {
+  const today = new Date()
+  const month = today.getUTCMonth()
+  if (month < 2 || month > 10) return 'Winter'
+  if (month < 5) return 'Spring'
+  if (month < 8) return 'Summer'
+  return 'Autumn'
+}
+
+function getTimeOfDay() {
+  const hour = new Date().getUTCHours()
+  if (hour < 6 || hour > 20) return 'Night'
+  if (hour < 12) return 'Morning'
+  if (hour < 18) return 'Afternoon'
+  return 'Evening'
+}
+
+const generator = function (faker: Faker, options: SimulatePubOptions) {
+  const { clientId } = options
+  if (!dataCache[clientId]) {
+    dataCache[clientId] = {
+      station_id: faker.datatype.uuid(),
+      city: faker.address.city(),
+      region: faker.address.state(),
+      latitude: faker.address.latitude(),
+      longitude: faker.address.longitude(),
+    }
+  }
+
+  const season = getCurrentSeason()
+  const timeOfDay = getTimeOfDay()
+
+  const isDay = timeOfDay === 'Night' ? 0 : 1
+  const tempMin = season === 'Winter' ? -20 : 0
+  const tempMax = season === 'Summer' ? 40 : 20
+  const condition = isDay ? 'Clear' : 'Cloudy'
+
+  const data = {
+    ...dataCache[clientId],
+    current: {
+      last_updated_epoch: Date.now(),
+      last_updated: new Date().toLocaleString(),
+      temp_c: faker.datatype.number({ min: tempMin, max: tempMax, precision: 0.1 }),
+      temp_f: faker.datatype.number({ min: tempMin * 1.8 + 32, max: tempMax * 1.8 + 32, precision: 0.1 }),
+      is_day: isDay,
+      condition: {
+        text: condition,
+        icon: faker.image.imageUrl(),
+        code: faker.datatype.number({ min: 1000, max: 2000 }),
+      },
+      wind_mph: faker.datatype.number({ min: 0, max: 100 }),
+      wind_kph: faker.datatype.number({ min: 0, max: 161 }),
+      wind_degree: faker.datatype.number({ min: 0, max: 360 }),
+      wind_dir: faker.helpers.arrayElement(['N', 'S', 'E', 'W']),
+      pressure_mb: faker.datatype.number({ min: 980, max: 1040 }),
+      pressure_in: faker.datatype.number({ min: 28.9, max: 30.7, precision: 0.1 }),
+      precip_mm: season === 'Summer' ? faker.datatype.number({ min: 0, max: 50, precision: 0.1 }) : 0,
+      precip_in: season === 'Summer' ? faker.datatype.number({ min: 0, max: 1.97, precision: 0.01 }) : 0,
+      humidity: faker.datatype.number({ min: 0, max: 100 }),
+      cloud: isDay ? faker.datatype.number({ min: 0, max: 50 }) : faker.datatype.number({ min: 50, max: 100 }),
+      feelslike_c: faker.datatype.number({ min: tempMin, max: tempMax, precision: 0.1 }),
+      feelslike_f: faker.datatype.number({ min: tempMin * 1.8 + 32, max: tempMax * 1.8 + 32, precision: 0.1 }),
+      vis_km: isDay ? faker.datatype.number({ min: 0, max: 100 }) : faker.datatype.number({ min: 0, max: 50 }),
+      vis_miles: isDay ? faker.datatype.number({ min: 0, max: 62 }) : faker.datatype.number({ min: 0, max: 31 }),
+      uv: isDay ? faker.datatype.number({ min: 0, max: 10 }) : 0,
+      gust_mph: faker.datatype.number({ min: 0, max: 100 }),
+      gust_kph: faker.datatype.number({ min: 0, max: 161 }),
+      air_quality: {
+        co: faker.datatype.number({ min: 0, max: 500 }),
+        no2: faker.datatype.number({ min: 0, max: 1, precision: 0.01 }),
+        o3: faker.datatype.number({ min: 0, max: 100 }),
+        so2: faker.datatype.number({ min: 0, max: 1, precision: 0.01 }),
+        pm2_5: faker.datatype.number({ min: 0, max: 1, precision: 0.01 }),
+        pm10: faker.datatype.number({ min: 0, max: 5 }),
+        'us-epa-index': faker.datatype.number({ min: 0, max: 5 }),
+        'gb-defra-index': faker.datatype.number({ min: 0, max: 5 }),
+      },
+    },
+  }
+
+  return {
+    message: JSON.stringify(data),
+  }
+}
+
+const name = 'weather'
+const author = 'EMQX Team'
+const dataFormat = 'JSON'
+const version = '0.0.1'
+const description = "Simulation to generate advanced weather station's data."
+
+export { generator, name, author, dataFormat, version, description }

scripts-example/IoT-data-scenarios/weather.js

@@ -0,0 +1,128 @@
+/**
+ * Weather Station Data Simulation Script
+ *
+ * This script simulates a weather station and generates weather-related data such as temperature, humidity,
+ * wind speed, wind direction, and precipitation. It includes characteristics of a weather station such as city,
+ * region, latitude, and longitude. The generated data is represented as a JSON object.
+ *
+ * The script uses the Faker.js library to generate fake data. Each weather station is represented by a unique
+ * station_id, and each time the script is run, it generates a current weather report for that station.
+ *
+ * The weather data includes information about:
+ * - Temperature (in Celsius and Fahrenheit)
+ * - Whether it's day or night
+ * - Weather conditions (e.g., clear, cloudy, rain, snow)
+ * - Wind speed and direction
+ * - Atmospheric pressure
+ * - Precipitation amount
+ * - Humidity percentage
+ * - Cloud cover percentage
+ * - 'Feels like' temperature (in Celsius and Fahrenheit)
+ * - Visibility distance
+ * - Ultraviolet radiation level
+ * - Gust speed
+ * - Air quality indicators (CO, NO2, O3, SO2, PM2.5, PM10, and indexes from the US EPA and GB DEFRA)
+ *
+ * Note: The script does not adjust the generated data according to different times of day (e.g., morning, afternoon,
+ * evening) or seasons (e.g., spring, summer, autumn, winter). The generated data should be used for simulation
+ * purposes only and does not represent real-world weather conditions.
+ *
+ * @module weather
+ * @version 0.0.1
+ * @author EMQX Team
+ */
+
+const dataCache = {}
+
+function getCurrentSeason() {
+  const today = new Date()
+  const month = today.getUTCMonth()
+  if (month < 2 || month > 10) return 'Winter'
+  if (month < 5) return 'Spring'
+  if (month < 8) return 'Summer'
+  return 'Autumn'
+}
+
+function getTimeOfDay() {
+  const hour = new Date().getUTCHours()
+  if (hour < 6 || hour > 20) return 'Night'
+  if (hour < 12) return 'Morning'
+  if (hour < 18) return 'Afternoon'
+  return 'Evening'
+}
+
+const generator = function (faker, options) {
+  const { clientId } = options
+  if (!dataCache[clientId]) {
+    dataCache[clientId] = {
+      station_id: faker.datatype.uuid(),
+      city: faker.address.city(),
+      region: faker.address.state(),
+      latitude: faker.address.latitude(),
+      longitude: faker.address.longitude(),
+    }
+  }
+
+  const season = getCurrentSeason()
+  const timeOfDay = getTimeOfDay()
+
+  const isDay = timeOfDay === 'Night' ? 0 : 1
+  const tempMin = season === 'Winter' ? -20 : 0
+  const tempMax = season === 'Summer' ? 40 : 20
+  const condition = isDay ? 'Clear' : 'Cloudy'
+
+  const data = {
+    ...dataCache[clientId],
+    current: {
+      last_updated_epoch: Date.now(),
+      last_updated: new Date().toLocaleString(),
+      temp_c: faker.datatype.number({ min: tempMin, max: tempMax, precision: 0.1 }),
+      temp_f: faker.datatype.number({ min: tempMin * 1.8 + 32, max: tempMax * 1.8 + 32, precision: 0.1 }),
+      is_day: isDay,
+      condition: {
+        text: condition,
+        icon: faker.image.imageUrl(),
+        code: faker.datatype.number({ min: 1000, max: 2000 }),
+      },
+      wind_mph: faker.datatype.number({ min: 0, max: 100 }),
+      wind_kph: faker.datatype.number({ min: 0, max: 161 }),
+      wind_degree: faker.datatype.number({ min: 0, max: 360 }),
+      wind_dir: faker.helpers.arrayElement(['N', 'S', 'E', 'W']),
+      pressure_mb: faker.datatype.number({ min: 980, max: 1040 }),
+      pressure_in: faker.datatype.number({ min: 28.9, max: 30.7, precision: 0.1 }),
+      precip_mm: season === 'Summer' ? faker.datatype.number({ min: 0, max: 50, precision: 0.1 }) : 0,
+      precip_in: season === 'Summer' ? faker.datatype.number({ min: 0, max: 1.97, precision: 0.01 }) : 0,
+      humidity: faker.datatype.number({ min: 0, max: 100 }),
+      cloud: isDay ? faker.datatype.number({ min: 0, max: 50 }) : faker.datatype.number({ min: 50, max: 100 }),
+      feelslike_c: faker.datatype.number({ min: tempMin, max: tempMax, precision: 0.1 }),
+      feelslike_f: faker.datatype.number({ min: tempMin * 1.8 + 32, max: tempMax * 1.8 + 32, precision: 0.1 }),
+      vis_km: isDay ? faker.datatype.number({ min: 0, max: 100 }) : faker.datatype.number({ min: 0, max: 50 }),
+      vis_miles: isDay ? faker.datatype.number({ min: 0, max: 62 }) : faker.datatype.number({ min: 0, max: 31 }),
+      uv: isDay ? faker.datatype.number({ min: 0, max: 10 }) : 0,
+      gust_mph: faker.datatype.number({ min: 0, max: 100 }),
+      gust_kph: faker.datatype.number({ min: 0, max: 161 }),
+      air_quality: {
+        co: faker.datatype.number({ min: 0, max: 500 }),
+        no2: faker.datatype.number({ min: 0, max: 1, precision: 0.01 }),
+        o3: faker.datatype.number({ min: 0, max: 100 }),
+        so2: faker.datatype.number({ min: 0, max: 1, precision: 0.01 }),
+        pm2_5: faker.datatype.number({ min: 0, max: 1, precision: 0.01 }),
+        pm10: faker.datatype.number({ min: 0, max: 5 }),
+        'us-epa-index': faker.datatype.number({ min: 0, max: 5 }),
+        'gb-defra-index': faker.datatype.number({ min: 0, max: 5 }),
+      },
+    },
+  }
+
+  return {
+    message: JSON.stringify(data),
+  }
+}
+
+const name = 'weather'
+const author = 'EMQX Team'
+const dataFormat = 'JSON'
+const version = '0.0.1'
+const description = "Simulation to generate advanced weather station's data."
+
+module.export = { generator, name, author, dataFormat, version, description }