From 24949dac057c22040648b00ba42aded35226d7c9 Mon Sep 17 00:00:00 2001 From: Brian Towles Date: Tue, 22 Jun 2021 06:37:15 -0500 Subject: [PATCH] Modern forms integration documentation (#18130) Co-authored-by: Franck Nijhof --- source/_integrations/modern_forms.markdown | 72 ++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 source/_integrations/modern_forms.markdown diff --git a/source/_integrations/modern_forms.markdown b/source/_integrations/modern_forms.markdown new file mode 100644 index 00000000000..6666caa80aa --- /dev/null +++ b/source/_integrations/modern_forms.markdown @@ -0,0 +1,72 @@ +--- +title: Modern Forms +description: Instructions on how to integrate a Modern Forms Smart Fan with Home Assistant. +ha_category: + - Fan + - Light + - Switch +ha_release: 2021.7 +ha_iot_class: Local Polling +ha_config_flow: true +ha_quality_scale: none +ha_codeowners: + - '@wonderslug' +ha_domain: modern_forms +ha_zeroconf: true +ha_platforms: + - fan + - light + - switch +--- + +[Modern Forms](https://modernforms.com/) has a line of smart Wi-Fi-connected fans that allow for cloud or local control of the fan and light. There is support for individual sleep timers for the fan and light that can be set and cleared independently. + +{% include integrations/config_flow.md %} + +## Fans + +The Modern Forms integration has support for the Modern Forms fans. This includes directional support, and sleep timer services for the fan. + +## Lights + +The Modern Forms integration has support for the Modern Forms fans light. This includes brightness, and sleep timer services for the light. + +## Switches + +The Modern Forms integration provides support for the following toggleable attributes of a fan: + +- Away mode - to allow the fan simulate someone being home. +- Adaptive learning - for allow learning for away mode. +- Reboot - to reboot the control module. + +## Services + +### Service `modern_forms.clear_fan_sleep_timer` + +This service will clear the sleep timer for the fan if it has been set. It will not turn off the fan when the timer is cleared. + +### Service `modern_forms.clear_light_sleep_timer` + +This service will clear the sleep timer for the light if it has been set. It will not turn off the light when the timer is cleared. + +### Service `modern_forms.set_fan_sleep_timer` + +This service will set a sleep timer for the fan. When the sleep timer is expired it will turn off the fan. + +| Service Data Attribute | Required | Description | +| ---------------------- | -------- | -------------------------------------------------- | +| `sleep_time` | yes | The amount of time in minutes to set the sleep timer for. This is time in minutes from 1 to 1440 (1 day). | + +### Service `modern_forms.set_light_sleep_timer` + +This service will set a sleep timer for the light. When the sleep timer is expired it will turn off the light. + +| Service Data Attribute | Required | Description | +| ---------------------- | -------- | -------------------------------------------------- | +| `sleep_time` | yes | The amount of time in minutes to set the sleep timer for. This is time in minutes from 1 to 1440 (1 day).| + +
+ +Modern Forms Fans use NTP to pool.ntp.org in order to set its internal clock and check of sleep timers have expired. Sleep timers will only work if the Modern Forms Fans have internet NTP access. You can block off cloud access for the fan and only leave NTP (UDP port 123) outbound working for the sleep timers. + +