Closed #209 - Update help modals to point to documentation

js/component/card/alerts.js

@@ -170,7 +170,7 @@ beestat.component.card.alerts.prototype.decorate_top_right_ = function(parent) {
     .set_text('Help')
     .set_icon('help_circle')
     .set_callback(function() {
-      (new beestat.component.modal.help_alerts()).render();
+      window.open('https://www.notion.so/Alerts-dd453829dc7c47019a775130c93bde0c');
     });
   menu.add_menu_item(menu_item_help);
 };

js/component/card/comparison_settings.js

@@ -267,7 +267,7 @@ beestat.component.card.comparison_settings.prototype.decorate_top_right_ = funct
     .set_text('Help')
     .set_icon('help_circle')
     .set_callback(function() {
-      (new beestat.component.modal.help_comparison_settings()).render();
+      window.open('https://www.notion.so/Comparison-Settings-596040eadd014928830b4d1d54692761');
     }));
 };
 

js/component/card/my_home.js

@@ -211,6 +211,6 @@ beestat.component.card.my_home.prototype.decorate_top_right_ = function(parent)
     .set_text('Help')
     .set_icon('help_circle')
     .set_callback(function() {
-      (new beestat.component.modal.help_my_home()).render();
+      window.open('https://www.notion.so/My-Home-cc594772031e41a58ff38e04e66cf0ec');
     }));
 };

js/component/card/runtime_detail.js

@@ -244,7 +244,7 @@ beestat.component.card.runtime_detail.prototype.decorate_top_right_ = function(p
     .set_text('Help')
     .set_icon('help_circle')
     .set_callback(function() {
-      (new beestat.component.modal.help_runtime_detail()).render();
+      window.open('https://www.notion.so/Runtime-Detail-e499fb13fd4441f4b3f096baca1cb138');
     }));
 };
 

js/component/card/runtime_thermostat_summary.js

@@ -574,7 +574,7 @@ beestat.component.card.runtime_thermostat_summary.prototype.decorate_top_right_
     .set_text('Help')
     .set_icon('help_circle')
     .set_callback(function() {
-      (new beestat.component.modal.help_runtime_thermostat_summary()).render();
+      window.open('https://www.notion.so/Runtime-Summary-3225b739ebbc42d68a18260565fda4f1');
     }));
 };
 

js/component/card/score.js

@@ -205,7 +205,7 @@ beestat.component.card.score.prototype.decorate_top_right_ = function(parent) {
     .set_text('Help')
     .set_icon('help_circle')
     .set_callback(function() {
-      (new beestat.component.modal.help_score(self.type_)).render();
+      window.open('https://www.notion.so/Comparison-Scores-144d5dafbc6c43f7bc72341120717d8a');
     }));
 };
 

js/component/card/sensors.js

@@ -177,6 +177,6 @@ beestat.component.card.sensors.prototype.decorate_top_right_ = function(parent)
     .set_text('Help')
     .set_icon('help_circle')
     .set_callback(function() {
-      (new beestat.component.modal.help_sensors()).render();
+      window.open('https://www.notion.so/Sensors-d279d6fb4afc4f199409be2eb323140b');
     }));
 };

js/component/card/system.js

@@ -361,7 +361,7 @@ beestat.component.card.system.prototype.decorate_top_right_ = function(parent) {
     .set_text('Help')
     .set_icon('help_circle')
     .set_callback(function() {
-      (new beestat.component.modal.help_system()).render();
+      window.open('https://www.notion.so/beestat/System-44b441bdd99b4c3991d6e0ace2dce893');
     }));
 };
 

js/component/card/temperature_profiles.js

@@ -214,6 +214,6 @@ beestat.component.card.temperature_profiles.prototype.decorate_top_right_ = func
     .set_text('Help')
     .set_icon('help_circle')
     .set_callback(function() {
-      (new beestat.component.modal.help_temperature_profiles()).render();
+      window.open('https://www.notion.so/Temperature-Profiles-9c0fba6793dd4bc68f798c1516f0ea25');
     }));
 };

js/component/modal/help_alerts.js

@@ -1,19 +0,0 @@
-/**
- * Help for the alerts card.
- */
-beestat.component.modal.help_alerts = function() {
-  beestat.component.modal.apply(this, arguments);
-};
-beestat.extend(beestat.component.modal.help_alerts, beestat.component.modal);
-
-beestat.component.modal.help_alerts.prototype.decorate_contents_ = function(parent) {
-  parent.appendChild($.createElement('p').innerHTML('Shows alerts currently displayed on your thermostat and also custom beestat alerts. You may dismiss alerts at any time from beestat and it will not affect the alerts on your ecobee. Custom alerts include:'));
-  var ul = $.createElement('ul');
-  parent.appendChild(ul);
-  ul.appendChild($.createElement('li').innerHTML('Cool differential too low'));
-  ul.appendChild($.createElement('li').innerHTML('Heat differential too low'));
-};
-
-beestat.component.modal.help_alerts.prototype.get_title_ = function() {
-  return 'Alerts - Help';
-};

js/component/modal/help_comparison_settings.js

@@ -1,31 +0,0 @@
-/**
- * Comparison settings help.
- */
-beestat.component.modal.help_comparison_settings = function() {
-  beestat.component.modal.apply(this, arguments);
-};
-beestat.extend(beestat.component.modal.help_comparison_settings, beestat.component.modal);
-
-/**
- * Decorate
- *
- * @param {rocket.Elements} parent
- */
-beestat.component.modal.help_comparison_settings.prototype.decorate_contents_ = function(parent) {
-  parent.appendChild($.createElement('p').innerText('Comparison settings allow you to customize how your home is compared to the homes of other beestat users. All thermostats at the same physical address are compared together.'));
-
-  (new beestat.component.title('Region')).render(parent);
-  parent.appendChild($.createElement('p').innerText('Compare your home to other homes within 250 miles (400km) or expand this to all homes globally.'));
-
-  (new beestat.component.title('Property')).render(parent);
-  parent.appendChild($.createElement('p').innerHTML('The <em>Very Similar</em> option will compare with other homes with similar physical characteristics. This typically makes the most sense. The second option will compare with other homes of the same structure type (ex: Detached, Apartment). You may also compare with all other homes regardless of type, although this isn\'t generally very meaningful.'));
-};
-
-/**
- * Get the title.
- *
- * @return {string} The title.
- */
-beestat.component.modal.help_comparison_settings.prototype.get_title_ = function() {
-  return 'Comparison Settings - Help';
-};

js/component/modal/help_home_efficiency.js

@@ -1,17 +0,0 @@
-/**
- * Help for the home efficiency card.
- */
-beestat.component.modal.help_home_efficiency = function() {
-  beestat.component.modal.apply(this, arguments);
-};
-beestat.extend(beestat.component.modal.help_home_efficiency, beestat.component.modal);
-
-beestat.component.modal.help_home_efficiency.prototype.decorate_contents_ = function(parent) {
-  parent.appendChild($.createElement('p').innerHTML('Describes how quickly your home loses or gains heat compared to the temperature outside. The flatter this line the better your home keeps temperature without needing your heating or air conditioning to run.'));
-  parent.appendChild($.createElement('p').innerHTML('The data is sourced from your past year of history, looking at the rate of temperature change when your HVAC system is completely off. It is recalculated once a week.'));
-  parent.appendChild($.createElement('p').innerHTML('This feature is still in beta, and as such is not perfect. For example, this graph does not account for homes with multiple thermostats or secondary sources of heating/cooling such as window A/C units and space heaters.'));
-};
-
-beestat.component.modal.help_home_efficiency.prototype.get_title_ = function() {
-  return 'Home Efficiency - Help';
-};

js/component/modal/help_my_home.js

@@ -1,24 +0,0 @@
-/**
- * Help for the sensors card.
- */
-beestat.component.modal.help_my_home = function() {
-  beestat.component.modal.apply(this, arguments);
-};
-beestat.extend(beestat.component.modal.help_my_home, beestat.component.modal);
-
-beestat.component.modal.help_my_home.prototype.decorate_contents_ = function(parent) {
-  parent.appendChild($.createElement('p').innerHTML('These are all the properties of your home and HVAC system that are used in Home Comparisons.'));
-
-  new beestat.component.title('System').render(parent);
-  parent.appendChild($.createElement('p').innerHTML('Type of heating/cooling systems; detected automatically but are not always completely accurate due to lack of available data. They can be overridden by clicking on the <em>My Home</em> menu, then selecting <em>Change System Type</em>.'));
-
-  new beestat.component.title('Region').render(parent);
-  parent.appendChild($.createElement('p').innerHTML('Geographical region; determined automatically based on the address on the thermostat account.'));
-
-  new beestat.component.title('Property').render(parent);
-  parent.appendChild($.createElement('p').innerHTML('Physical property characteristics; determined automatically based on the data on the thermostat account.'));
-};
-
-beestat.component.modal.help_my_home.prototype.get_title_ = function() {
-  return 'My Home - Help';
-};

js/component/modal/help_runtime_detail.js

@@ -1,29 +0,0 @@
-/**
- * Help for the runtime detail card.
- */
-beestat.component.modal.help_runtime_detail = function() {
-  beestat.component.modal.apply(this, arguments);
-};
-beestat.extend(beestat.component.modal.help_runtime_detail, beestat.component.modal);
-
-beestat.component.modal.help_runtime_detail.prototype.decorate_contents_ = function(parent) {
-  parent.appendChild($.createElement('p').innerHTML('View up to the past 7 days of thermostat activity in 5-minute resolution. This can help you visualize daily runtime trends and identify acute system issues. Compare to the Home IQ System & Follow Me charts.'));
-
-  var table = $.createElement('table');
-  table.style('color', beestat.style.color.blue.base);
-  parent.appendChild(table);
-
-  var tr;
-  var td;
-
-  tr = $.createElement('tr');
-  table.appendChild(tr);
-
-  td = $.createElement('td');
-  td.setAttribute('valign', 'top');
-  tr.appendChild(td);
-};
-
-beestat.component.modal.help_runtime_detail.prototype.get_title_ = function() {
-  return 'Runtime Detail - Help';
-};

js/component/modal/help_runtime_thermostat_summary.js

@@ -1,39 +0,0 @@
-/**
- * Help for the aggregate runtime card.
- */
-beestat.component.modal.help_runtime_thermostat_summary = function() {
-  beestat.component.modal.apply(this, arguments);
-};
-beestat.extend(beestat.component.modal.help_runtime_thermostat_summary, beestat.component.modal);
-
-beestat.component.modal.help_runtime_thermostat_summary.prototype.decorate_contents_ = function(parent) {
-  parent.appendChild($.createElement('p').innerHTML('View HVAC usage trends over large periods of time. This can help you identify problems or visualize effeciency gains from new equipment, insulation, etc. Compare to the Home IQ Weather Impact chart.'));
-  parent.appendChild($.createElement('p').innerHTML('If you have Gap Fill enabled (on by default), this data may not match the ecobee website exactly. Ecobee displays total runtime as stored, while beestat will intelligently fill in missing data to produce a more accurate result.'));
-
-  var table = $.createElement('table');
-  table.style('color', beestat.style.color.blue.base);
-  parent.appendChild(table);
-
-  var tr;
-  var td;
-
-  tr = $.createElement('tr');
-  table.appendChild(tr);
-
-  td = $.createElement('td');
-  td.setAttribute('valign', 'top');
-  tr.appendChild(td);
-
-  (new beestat.component.icon('information')
-    .set_color(beestat.style.color.blue.base)
-  ).render(td);
-
-  td = $.createElement('td');
-  td.setAttribute('valign', 'top');
-  tr.appendChild(td);
-  td.innerHTML('Ecobee typically purges data after about a year. Beestat stores all historical data even though ecobee does not.');
-};
-
-beestat.component.modal.help_runtime_thermostat_summary.prototype.get_title_ = function() {
-  return 'Runtime Summary - Help';
-};

js/component/modal/help_score.js

@@ -1,138 +0,0 @@
-/**
- * Score help
- *
- * @param {string} type heat|cool|resist
- */
-beestat.component.modal.help_score = function(type) {
-  this.type_ = type;
-  beestat.component.modal.apply(this, arguments);
-};
-beestat.extend(beestat.component.modal.help_score, beestat.component.modal);
-
-/**
- * Decorate
- *
- * @param {rocket.Elements} parent
- */
-beestat.component.modal.help_score.prototype.decorate_contents_ = function(parent) {
-  (new beestat.component.title('What is this value?')).render(parent);
-  var what_is;
-  switch (this.type_) {
-  case 'heat':
-    what_is = 'Your heat score represents how well your home heats compared to other homes. The most important factor is the rate at which temperature increases. However, you also receive a bonus to this score for having longer cycle times. Aux heating is not used when generating this score.';
-    break;
-  case 'cool':
-    what_is = 'Your cool score represents how well your home cool compared to other homes. The most important factor is the rate at which temperature decreases. However, you also receive a bonus to this score for having longer cycle times.';
-    break;
-  case 'resist':
-    what_is = 'Your resist score represents how well your home is able to maintain a consistent temperature without the help of your HVAC system. For example, if you have a very drafty home that loses heat quickly in the winter, this score will be low. If you have a home with good insulation, this score will be high.';
-    break;
-  }
-  parent.appendChild($.createElement('p').innerText(what_is));
-
-  (new beestat.component.title('How is my ' + this.type_ + ' score calculated?')).render(parent);
-  parent.appendChild($.createElement('p').innerText('The currently displayed score was calculated using the following parameters:'));
-
-  var strings = [];
-
-  var comparison_attributes = beestat.home_comparisons.get_comparison_attributes(this.type_);
-
-  if (comparison_attributes.system_type_heat !== undefined) {
-    strings.push('Heat Type: ' + this.get_comparison_string_(comparison_attributes.system_type_heat));
-  } else {
-    strings.push('Heat Type: Not considered');
-  }
-
-  if (comparison_attributes.system_type_heat_auxiliary !== undefined) {
-    strings.push('Aux Heat Type: ' + this.get_comparison_string_(comparison_attributes.system_type_heat_auxiliary));
-  } else {
-    strings.push('Aux Heat Type: Not considered');
-  }
-
-  if (comparison_attributes.system_type_cool !== undefined) {
-    strings.push('Cool Type: ' + this.get_comparison_string_(comparison_attributes.system_type_cool));
-  } else {
-    strings.push('Cool Type: Not considered');
-  }
-
-  if (comparison_attributes.property_structure_type !== undefined) {
-    strings.push('Property Type: ' + this.get_comparison_string_(comparison_attributes.property_structure_type));
-  } else {
-    strings.push('Property Type: Not considered');
-  }
-
-  if (comparison_attributes.property_age !== undefined) {
-    strings.push(this.get_comparison_string_(comparison_attributes.property_age, 'years old'));
-  } else {
-    strings.push('Property age not considered');
-  }
-
-  if (comparison_attributes.property_square_feet !== undefined) {
-    strings.push(this.get_comparison_string_(comparison_attributes.property_square_feet, 'sqft'));
-  } else {
-    strings.push('Square footage not considered');
-  }
-
-  if (comparison_attributes.property_stories !== undefined) {
-    strings.push(this.get_comparison_string_(comparison_attributes.property_stories, 'stories'));
-  } else {
-    strings.push('Number of stories not considered');
-  }
-
-  if (comparison_attributes.address_radius !== undefined) {
-    strings.push('Within ' + comparison_attributes.address_radius + ' miles of your location');
-  } else {
-    strings.push('Region not considered');
-  }
-
-  var ul = $.createElement('ul');
-  parent.appendChild(ul);
-  strings.forEach(function(string) {
-    var li = $.createElement('li');
-    li.innerText(string);
-    if (string.match('considered') !== null) {
-      li.style({'color': beestat.style.color.gray.base});
-    }
-    ul.appendChild(li);
-  });
-};
-
-/**
- * Get the title.
- *
- * @return {string} The title.
- */
-beestat.component.modal.help_score.prototype.get_title_ = function() {
-  return this.type_.charAt(0).toUpperCase() + this.type_.slice(1) + ' Score - Help';
-};
-
-/**
- * Helper function to display various comparison strings in a human-readable
- * way.
- *
- * @param {mixed} comparison_attribute The attribute
- * @param {string} suffix If a suffix (ex: "years") should be placed on the
- * end.
- *
- * @return {string} The human-readable string.
- */
-beestat.component.modal.help_score.prototype.get_comparison_string_ = function(comparison_attribute, suffix) {
-  var s = (suffix !== undefined ? (' ' + suffix) : '');
-  if (comparison_attribute.operator !== undefined) {
-    if (comparison_attribute.operator === 'between') {
-      return 'Between ' + comparison_attribute.value[0] + ' and ' + comparison_attribute.value[1] + s;
-    } else if (comparison_attribute.operator === '>=') {
-      return 'At least ' + comparison_attribute.value + s;
-    } else if (comparison_attribute.operator === '<=') {
-      return 'Less than or equal than ' + comparison_attribute.value + s;
-    } else if (comparison_attribute.operator === '>') {
-      return 'Greater than ' + comparison_attribute.value + s;
-    } else if (comparison_attribute.operator === '<') {
-      return 'Less than' + comparison_attribute.value + s;
-    }
-    return comparison_attribute.operator + ' ' + comparison_attribute.value + s;
-  } else if (Array.isArray(comparison_attribute.value) === true) {
-    return 'One of ' + comparison_attribute.value.join(', ') + s;
-  }
-  return comparison_attribute + s;
-};

js/component/modal/help_sensors.js

@@ -1,22 +0,0 @@
-/**
- * Help for the sensors card.
- */
-beestat.component.modal.help_sensors = function() {
-  beestat.component.modal.apply(this, arguments);
-};
-beestat.extend(beestat.component.modal.help_sensors, beestat.component.modal);
-
-beestat.component.modal.help_sensors.prototype.decorate_contents_ = function(parent) {
-  parent.appendChild($.createElement('p').innerHTML('Shows a list of all connected sensors. The thermostat itself counts as a sensor and is displayed at the top of the list. Includes the following information:'));
-  var ul = $.createElement('ul');
-  parent.appendChild(ul);
-  ul.appendChild($.createElement('li').innerHTML('Name'));
-  ul.appendChild($.createElement('li').innerHTML('Temperature'));
-  ul.appendChild($.createElement('li').innerHTML('Whether the temperature is above or below the average'));
-  ul.appendChild($.createElement('li').innerHTML('Occupancy'));
-  ul.appendChild($.createElement('li').innerHTML('Included in average'));
-};
-
-beestat.component.modal.help_sensors.prototype.get_title_ = function() {
-  return 'Sensors - Help';
-};

js/component/modal/help_system.js

@@ -1,24 +0,0 @@
-/**
- * Help for the system card.
- */
-beestat.component.modal.help_system = function() {
-  beestat.component.modal.apply(this, arguments);
-};
-beestat.extend(beestat.component.modal.help_system, beestat.component.modal);
-
-beestat.component.modal.help_system.prototype.decorate_contents_ = function(parent) {
-  parent.appendChild($.createElement('p').innerHTML('Shows the current system status it would be displayed on the thermostat itself. Includes the following information:'));
-  var ul = $.createElement('ul');
-  parent.appendChild(ul);
-  ul.appendChild($.createElement('li').innerHTML('System Mode'));
-  ul.appendChild($.createElement('li').innerHTML('Schedule or Override'));
-  ul.appendChild($.createElement('li').innerHTML('Setpoint'));
-  ul.appendChild($.createElement('li').innerHTML('Temperature'));
-  ul.appendChild($.createElement('li').innerHTML('Humidity'));
-  ul.appendChild($.createElement('li').innerHTML('Running equipment'));
-  ul.appendChild($.createElement('li').innerHTML('Active comfort setting'));
-};
-
-beestat.component.modal.help_system.prototype.get_title_ = function() {
-  return 'System - Help';
-};

js/component/modal/help_temperature_profiles.js

@@ -1,41 +0,0 @@
-/**
- * Temperature Profiles help.
- *
- * @param {string} type heat|cool|resist
- * @param {array} comparison_attributes
- */
-beestat.component.modal.help_temperature_profiles = function() {
-  beestat.component.modal.apply(this, arguments);
-};
-beestat.extend(beestat.component.modal.help_temperature_profiles, beestat.component.modal);
-
-/*
-Describes how quickly your home loses or gains heat compared to the temperature outside. The flatter this line the better your home keeps temperature without needing your heating or air conditioning to run.
-
-The data is sourced from your past year of history, looking at the rate of temperature change when your HVAC system is completely off. It is recalculated once a week.
-
-This feature is still in beta, and as such is not perfect. For example, this graph does not account for homes with multiple thermostats or secondary sources of heating/cooling such as window A/C units and space heaters.*/
-
-/**
- * Decorate
- *
- * @param {rocket.Elements} parent
- */
-beestat.component.modal.help_temperature_profiles.prototype.decorate_contents_ = function(parent) {
-  parent.appendChild($.createElement('p').innerText('Temperature profiles tell you how fast or slow your indoor temperature changes. This is powerful information that can tell you a lot about your home and help you make informed decisions.'));
-
-  (new beestat.component.title('Heat / Cool')).render(parent);
-  parent.appendChild($.createElement('p').innerText('The orange and blue lines represent the rate at which your home heats or cools for any given outdoor temperature. The dotted lines are the raw data, and the solid line is a trendline for that data. For heat pump owners, the outdoor temperature where the orange line crosses the x-axis is called your balance point and tells you when you need an auxiliary source of heat to keep your home warm.'));
-
-  (new beestat.component.title('Resist')).render(parent);
-  parent.appendChild($.createElement('p').innerText('The gray line represents the rate at which your home gains or loses heat when your HVAC system is completely off. The dotted lines are the raw data, and the solid line is a trendline for that data.'));
-};
-
-/**
- * Get the title.
- *
- * @return {string} The title.
- */
-beestat.component.modal.help_temperature_profiles.prototype.get_title_ = function() {
-  return 'Temperature Profiles - Help';
-};

js/js.php

@@ -77,19 +77,9 @@ if($setting->get('environment') === 'dev' || $setting->get('environment') === 'd
   echo '<script src="/js/component/modal/download_data.js"></script>' . PHP_EOL;
   echo '<script src="/js/component/modal/error.js"></script>' . PHP_EOL;
   echo '<script src="/js/component/modal/filter_info.js"></script>' . PHP_EOL;
-  echo '<script src="/js/component/modal/help_runtime_thermostat_summary.js"></script>' . PHP_EOL;
-  echo '<script src="/js/component/modal/help_alerts.js"></script>' . PHP_EOL;
-  echo '<script src="/js/component/modal/help_home_efficiency.js"></script>' . PHP_EOL;
-  echo '<script src="/js/component/modal/help_my_home.js"></script>' . PHP_EOL;
-  echo '<script src="/js/component/modal/help_runtime_detail.js"></script>' . PHP_EOL;
-  echo '<script src="/js/component/modal/help_sensors.js"></script>' . PHP_EOL;
-  echo '<script src="/js/component/modal/help_system.js"></script>' . PHP_EOL;
-  echo '<script src="/js/component/modal/help_comparison_settings.js"></script>' . PHP_EOL;
-  echo '<script src="/js/component/modal/help_temperature_profiles.js"></script>' . PHP_EOL;
   echo '<script src="/js/component/modal/enjoy_beestat.js"></script>' . PHP_EOL;
   echo '<script src="/js/component/modal/runtime_detail_custom.js"></script>' . PHP_EOL;
   echo '<script src="/js/component/modal/thermostat_info.js"></script>' . PHP_EOL;
-  echo '<script src="/js/component/modal/help_score.js"></script>' . PHP_EOL;
   echo '<script src="/js/component/modal/weather.js"></script>' . PHP_EOL;
   echo '<script src="/js/component/input.js"></script>' . PHP_EOL;
   echo '<script src="/js/component/input/text.js"></script>' . PHP_EOL;