Getting Started
This guide gives new users a first path through GreenSparks. It is written for the current app and site: public documentation is available without signing in, while the app and private business/admin material require a GreenSparks account.
1. Sign In
Use Open app from the public site or go directly to the GreenSparks app. If you are not already authenticated, sign in with your GreenSparks account.
After sign-in, the app should show the main navigation. Depending on account state and permissions, some administrative or user-management actions may not be available.
Expected result: You can see the app shell and move between top-level sections such as Events, Venues, Devices, People, Agents, Readings, and Report.
2. Check The Data Environment
In local development, GreenSparks can expose a Dev/Prod data selector. Use it to choose whether the app is using local development data or the hosted production data environment.
In the hosted production app, the selector is hidden and production data is assumed.
Expected result: Local development can switch between Dev and Prod. The hosted app should not try to connect to localhost services.
3. Start With Events Or Venues
Events and Venues are useful first stops because they show how GreenSparks organizes real-world operating context. These sections help connect devices and zones to the places where work is happening.
Look for:
- event or venue tree navigation
- zones or child locations
- links from a selected item into maps, reports, or related detail views
Expected result: You understand the operating structure before inspecting readings or reports.
4. Inspect Devices
The Devices section helps explain what is being monitored. Devices may be organized through categories and products/templates, depending on the data environment and available records.
Look for:
- device tree hierarchy
- product/template information
- links to readings, reports, maps, or engineering/admin views where permitted
Expected result: You can identify a device, understand where it belongs, and move from the device to related operational views.
5. Review Readings
Readings show telemetry-related data collected or imported into GreenSparks. A reading by itself is rarely the full story, so use readings together with device, event, venue, and report context.
Expected result: You can inspect recent or historical values and then decide whether a report, map, or device detail view gives better context.
6. Open Reports
Reports help move from individual records to scoped review. GreenSparks supports report views across several scopes, including devices, products/templates, zones, events, and venues.
Expected result: You can choose a report scope, review the displayed data, and use export or publication-oriented controls where they are available.
7. Use Help While You Work
The app includes page-level help and search. Short help topics explain the current page or concept; longer public guides provide more workflow context.
Expected result: If a term or page is unfamiliar, Help should get you to a useful explanation without leaving you to infer the app model from the UI alone.
What Is Coming Later
This guide will become more visual as screenshots and diagrams are added. The next useful additions are screenshots for Events, Venues, Devices, Readings, Reports, Agents, and People/Profile, plus a simple diagram of how devices, zones, venues, and events relate.