YenGear

Appearance

Data Model Basics for YenGear IoT Cloud ​

Welcome! This guide explains the core concepts you will see in YenGear IoT Cloud (UMS): Organization, Project, Device, and Factor. It is written for first-time users with no technical background.

Why these concepts matter ​

  • Keep your data organized as your fleet grows.
  • Control who can see or edit data.
  • Connect sensors once, then reuse their data in dashboards, alerts, and exports.

Organization ​

  • Think of an organization as your company or team workspace.
  • Every user belongs to one or more organizations. Organization admins invite teammates and manage access.
  • Settings at this level apply to all projects under the organization.

Project ​

  • A project is a container for devices that belong to the same site or scenario (e.g., "Greenhouse A", "Cold Chain Warehouse").
  • Use projects to separate data by location, customer, or business line.
  • Project IDs stay unique in the platform; they appear in URLs and API calls.

Device ​

  • A device represents a physical gateway, controller, or sensor node that sends data to the cloud.
  • Each device has a Device ID (hardware identifier) and a platform devicePk (internal primary key used by the UI/API).
  • Devices live inside projects; moving them between projects changes where their data appears.

Factor ​

  • A factor is a single measurement point on a device (e.g., temperature, humidity, CO₂, door status).
  • Each factor has its own factorPk (internal key) and name/unit shown in charts and exports.
  • Factors let you manage and view multiple sensor readings from one device separately.

How data flows (simple view) ​

  1. Your device sends data to YenGear IoT Cloud.
  2. The platform matches the device and its factors.
  3. Data appears in the project dashboards and can be forwarded to other systems (see Data Forwarding).

Typical setup steps ​

  1. Create an Organization: Your workspace; invite teammates later.
  2. Create a Project: One per site or customer.
  3. Add a Device: Enter the device ID and basic info.
  4. Add Factors: Name each measurement (e.g., "Indoor Temp", unit "°C").
  5. View Data: Open the project dashboard to see live values and history.

Tips for new users ​

  • Keep names simple and human-readable (e.g., "North Field Gateway", "Indoor Temp").
  • Use one project per site to avoid mixing data.
  • Add factors right after adding a device so charts show friendly names instead of codes.
  • Want to send data to your own tools? Use Forwarder Profiles in the Org menu to create webhooks, MQTT, or database exports.

Where to manage these items ​

  • In the UMS web app, open the left sidebar:
    • Organization: Member access, forwarding profiles, shared settings.
    • Project: Device list, device details, charts, alerts.
    • Device: Factor list, real-time data, history, commands (if available).

Need help? Email [email protected].