Now-a-days IOT is gaining popularity in variety of usecases. We built IOT-SaaS, a prototype for IOT based usage in Aquaculture. Users can register to platform, subscribe for a device and get Real-Time alerts and Dashboard on the fly.
User registers and logins to platform with an Email & Password. User can see list of available devices. Once user subscribes and pays for a device, Device will be installed at User site location.
Once device has been installed on User's site location, data will be pushed to MQTT brokers which will be pushed to Kafka broker for message streaming purpose. MongoDB-Kafka connector pumps data from Kafka brokers to MongoDB Atlas. This data will be used for Real-Time alerts and dashboard.
User can Suspend or Resume a device from application at his convenience. Consolidated bill will be generated for a user every month based on number of days each subscribed device has been used.
User registers and logins to platform with an Email & Password. User can see list of available devices. Once user subscribes for a device, data will be simulated to MongoDB Atlas similar to Real-World IOT device to demonstrate Real-Time alerts and dashboard behaviour.
User can Suspend or Resume a device from application at his convenience. Consolidated bill will be generated for a user every month based on number of days each subscribed device has been used.
IOT-SaaS is an ReactJS application built using MongoDB Realm Webclient SDKs and hosted in MongoDB Realm Hosting. All data is stored in MongoDB Atlas collections and manipulated using MongoDB Realm Functions. Application uses MongoDB Realm Email/Password Authentication provider. Each collection are enabled with Data Access Rules for extra layer of authorization.
- devices:
- devices master data created by Admin - contains device information
- Rules: Any can Ready-Only
- Indexes:
- Search index: on field title as type Autocomplete for device search AutoCompletions
- Text index: on field title & description
- user_device_subscriptions:
- on user subscribing a device, entry will be placed to this collection
- suspended field specifies if user Suspended or Resumed device
- Rules: User can Write/Read only their data
- user_device_usage:
- contains information of device and date representing user's subscribed device is in use
- Data in this collection inserted using Scheduled trigger: userDeviceUsageTracker function everyday.
- Data will be used for Bill generation
- Rules: User can Read-Only only their data
- sensor_data:
- Timeseries collection
- Scheduled trigger: simulator function generates data for every record of user_device_subscriptions collection, where suspended:false into this collection for every 5 minutes.
- Data in this collection represents sensors or devices generated raw data. (Simulated using scheduled trigger for proto type purpose)
- Data has expireAfterSeconds set as 86400 and granularity as minutes
- Rules: User can Read-Only only their data
- aggregated_sensor_data:
- Scheduled trigger: aggregatedSensorData function aggregates data from sensor_data for every 15 minutes and inserts into this collection for every userId and deviceId
- Data in this collection represents sensors or devices aggregated data. (Aggregated and Inserted using scheduled trigger)
- Rules: User can Read-Only only their data
- alerts:
- Database trigger: validateAggregatedData function validates latest aggregated value of every userId & deviceId and checks if aggregated value is breaching alert condition of that device. If breaching, new record will be inserted into this collection.
- Alert condition of device is present in devices collection
- If aggregated value breaches this condition, new entry will be inserted
- Rules: User can Read-Only only their data
- user_bills:
- Scheduled trigger: generateMonthlyUserBills function generates monthly bill using records of user_device_usage
- This contain bill details for every user for every month
- Bill Generated formula: SUM(Each device per day price * number of devices this device is used/active/suspended:false)
- Rules: User can Write/Read only their data
- simulator:
- Trigger Type: Scheduled
- Condition:
*/1 * * * * - Responsibility:
- Generate mock data similar to real-world device/sensor data based on configurations at devices collection
- For every entry of user_device_subscriptions collection where suspended:false, generate a random value from the range of min & max configured in devices collection and insert into sensor_data collection
- aggregatedSensorData:
- Trigger Type: Scheduled
- Condition: */10 * * * *
- Responsibility:
- Aggregate last 10 minutes data from sensor_data collection for every userId & deviceId and get Avg. value
- Insert calculated avg. value into aggregated_sensor_data collection
- validateAggregatedData:
- Trigger Type: Database
- Condition: For every insert operation on aggregated_sensor_data collection
- Responsibility:
- Get avg. value from inserted data of aggregated_sensor_data collection came from trigger event
- Get alert condition of current device by id from devices collection
- Check if alert condition breached. If breached, insert new entry to alerts collection
- userDeviceUsageTracker:
- Trigger Type: Scheduled
- Condition: 0 0 * * *
- Responsibility:
- On Every day, gets records from user_device_subscriptions collection where suspended:false and insert a record into user_device_usage collection
- This inserted data into user_device_usage collection is further used for billing purpose
- generateMonthlyUserBills:
- Trigger Type: Scheduled
- Condition: 0 0 1 * *
- Responsibility:
- On Every month, get records from user_device_usage collection with aggregation to get records as userId grouped by deviceId and days used count
- For every user, calculate consolidated bill by sum(each device price per day * device days used in previous month)
- device price per day available from master data collection: devices# Realm Functions
- getDevices:
- Returns all devices
- getDeviceById:
- Takes deviceId and return device by matching _id
- autocompleteTitle:
- Takes search term and return matched device titles
- Utilizes device collection Search index
- search:
- Takes search term and return matched device on fields: titles or descriptions
- Utilizes device collection Text index
- subscribeDevice:
- Takes deviceId from request and userId from authorization context
- Creates entry to user_device_subscriptions collection with userId, deviceId
- suspendDevice:
- Takes deviceId from request and userId from authorization context
- Update suspended field to true in user_device_subscriptions collection on matching userId, deviceId record
- activateDevice
- Takes deviceId from request and userId from authorization context
- Update suspended field to false in user_device_subscriptions collection on matching userId, deviceId record
- getUserDashboard
- Take userId from authorization context and seconds from request
- Return latest data of requested seconds from sensor_data collection matching userId group by deviceId
- getUserAggregatedDashboard
- Take userId from authorization context and seconds from request
- Return latest data of requested seconds from aggregated_sensor_data collection matching userId group by deviceId
- getUserAlerts
- Take userId from authorization context
- Return latest data from alerts collection matching userId
- getUserBills
- Take userId from authorization context
- Return bills from user_bills collection matching userId
- getUserDeviceUsage
- Take userId from authorization context
- Return data from user_device_usage collection matching userId
- getUserDevices
- Take userId from authorization context
- Return data from devices collection matching userId
- payBill
- Take billId from request and userId from authorization context
- Updated field paid:true matching billId & userId
