refactor(temp): Mark %temperature% token as deprecated

This commit is contained in:
patrick96 2017-12-10 11:28:07 +01:00 committed by NBonaparte
parent e4634ce95f
commit a9014e31dc
2 changed files with 12 additions and 4 deletions

View File

@ -356,8 +356,8 @@ format-underline = #f50a4d
format-warn = <ramp> <label-warn> format-warn = <ramp> <label-warn>
format-warn-underline = ${self.format-underline} format-warn-underline = ${self.format-underline}
label = %temperature% label = %temperature-c%
label-warn = %temperature% label-warn = %temperature-c%
label-warn-foreground = ${colors.secondary} label-warn-foreground = ${colors.secondary}
ramp-0 = ramp-0 =

View File

@ -32,14 +32,20 @@ namespace modules {
m_formatter->add(FORMAT_WARN, TAG_LABEL_WARN, {TAG_LABEL_WARN, TAG_RAMP}); m_formatter->add(FORMAT_WARN, TAG_LABEL_WARN, {TAG_LABEL_WARN, TAG_RAMP});
if (m_formatter->has(TAG_LABEL)) { if (m_formatter->has(TAG_LABEL)) {
m_label[temp_state::NORMAL] = load_optional_label(m_conf, name(), TAG_LABEL, "%temperature%"); m_label[temp_state::NORMAL] = load_optional_label(m_conf, name(), TAG_LABEL, "%temperature-c%");
} }
if (m_formatter->has(TAG_LABEL_WARN)) { if (m_formatter->has(TAG_LABEL_WARN)) {
m_label[temp_state::WARN] = load_optional_label(m_conf, name(), TAG_LABEL_WARN, "%temperature%"); m_label[temp_state::WARN] = load_optional_label(m_conf, name(), TAG_LABEL_WARN, "%temperature-c%");
} }
if (m_formatter->has(TAG_RAMP)) { if (m_formatter->has(TAG_RAMP)) {
m_ramp = load_ramp(m_conf, name(), TAG_RAMP); m_ramp = load_ramp(m_conf, name(), TAG_RAMP);
} }
// Deprecation warning for the %temperature% token
if((m_label[temp_state::NORMAL] && m_label[temp_state::NORMAL]->has_token("%temperature%")) ||
((m_label[temp_state::WARN] && m_label[temp_state::WARN]->has_token("%temperature%")))) {
m_log.warn("%s: The token `%%temperature%%` is deprecated, use `%%temperature-c%%` instead.", name());
}
} }
bool temperature_module::update() { bool temperature_module::update() {
@ -53,6 +59,8 @@ namespace modules {
label->replace_token("%temperature-c%", to_string(m_temp) + "°C"); label->replace_token("%temperature-c%", to_string(m_temp) + "°C");
label->replace_token("%temperature-f-n%", to_string(m_temp_f)); label->replace_token("%temperature-f-n%", to_string(m_temp_f));
label->replace_token("%temperature-c-n%", to_string(m_temp)); label->replace_token("%temperature-c-n%", to_string(m_temp));
// DEPRECATED: Will be removed in later release
label->replace_token("%temperature%", to_string(m_temp) + "°C"); label->replace_token("%temperature%", to_string(m_temp) + "°C");
}; };