Dashboard application for Smartclime devices.
The server-side scripts are contained in \scripts. These are hosted by Scriptr.io which manages all incoming device data from the SmartClime systems. These scripts handle all of the package parsing and interface to the databases.
Customer data, business and relationship associations, and current telemetry data are stored in a Firebase managed NoSQL database.
Historical analytics are performed through a managed service called Keen.io. Event data is logged through the backend scripts to Keen, and queries are performed on the fly from the front-end on demand via Keen's web API.
The front-end application is based on Ember.JS, which is an open-source web framework ('single page application' or Javascript MVVM). Ember provides build tools through a CLI, a templating engine, an internal data model, and a web component framework supported by community add-ons.
Static files are hosted on Firebase. Firebase configuration is contained in firebase.json.
The dashboard@smartclime.com google account has ownership of the Firebase, Scriptr.io, and Keen.io accounts. Through that gmail account any of those services can be managed directly. Contact Ed Borden or Cari Bortfield for login info.
Access to this repository can be via individual Github accounts (contact Ed Borden to be added) or via an administrative account linked to smartclime@dashboard.com (contact Ed Borden for credentials).
The "Admin" role within the SmartClime dashboard allows for access to areas and functions for:
- Provisioning new devices into an organization
- Creating/Editing/Delete organizations
- Creating/Editing/Deleting users in an organization
The "Admin" role is automatically applied to all users within the SmartClime organization.
Alerts are created for the following conditions, limited to 1 per type, per device, in any 2 day period:
- Enter 'Override' or 'Bypass' at any time.
- For a device owned by an Organization with a 'Commercial' customer type, enter 'Run' or 'Save' between the hours of 8PM - 4AM, or anytime on Saturday or Sunday. This does take into account the time zone setting for the organization.
Current limitations of this system:
- For the after hours alert, if the device goes into 'Run' or 'Save' during normal hours, but then runs all night, the system doesn't check for that.
- Hours settings are not yet configurable, so for some type of business that might run during the weekends but not at night, you would be getting false alerts.
You will need the following things properly installed on your computer.
git clone <repository-url>this repository- change into the new directory
npm installbower install
ember serve- Visit your app at http://localhost:4200.
ember build
ember testember test --server
-
Staging: branch "staging" is linked to smartclime-staging on Firebase.
-
Production: branch "master" is linked to smartclime on Firebase.
Continuous Integration (CI) is managed via CircleCI. Updates to this Github repository will trigger a CircleCI build automatically. CircleCI configuration is contained in circle.yml. This configuration depends utilizes Firebase CLI directly, which depends on a local secret token, $FIREBASE_TOKEN. This token can be obtained using Firebase CLI locally with the command firebase login:ci.
- Does a fresh build
- Runs tests
- Deploys to Firebase