Add missing IoT classes to integration documentation

frenck commented 3 years ago

Context

All our integration is classified with an IoT class.

Classifier	Description
`Assumed State`	We are unable to get the state of the device. Best we can do is to assume the state based on our last command.
`Cloud Polling`	Integration of this device happens via the cloud and requires an active internet connection. Polling the state means that an update might be noticed later.
`Cloud Push`	Integration of this device happens via the cloud and requires an active internet connection. Home Assistant will be notified as soon as a new state is available.
`Local Polling`	Offers direct communication with device. Polling the state means that an update might be noticed later.
`Local Push`	Offers direct communication with device. Home Assistant will be notified as soon as a new state is available.
`Calculated`	The integration does not handle communication on it's own, but calculates the state.

The problem

Not all our documented integrations have this IoT class set, and we need help completing that.

The below listed integration are all missing the ha_iot_class: in the top of their Markdown files, specifying the IoT class of this issue.

Valid values are:

ha_iot_class: Assumed State
ha_iot_class: Cloud Polling
ha_iot_class: Cloud Push
ha_iot_class: Local Polling
ha_iot_class: Local Push
ha_iot_class: Calculated

If you open up a PR for one of the integration listed below, please make sure to mention #14661 in your PR description so it gets linked to this issue. Thanks!

Integrations that are missing IoT class

The following integrations are missing an IoT class:

[x] Actiontec page - source file
[x] Air Quality page - source file
[x] Alarm Control Panel page - source file
[x] Alert page - source file
[x] Amazon Alexa page - source file
[x] Amazon Polly page - source file
[x] Apache Kafka page - source file
[x] Home Assistant API page - source file
[x] Apple Push Notification Service (APNS) page - source file
[x] Apprise page - source file
[x] Arris TG2492LG page - source file
[x] Aruba page - source file
[x] Asterisk Call Detail Records page - source file
[x] ATEN Rack PDU page - source file
[x] Aurora page - source file
[x] Auth page - source file
[x] Automation page - source file
[x] Amazon Web Services (AWS) page - source file
[x] Azure Event Hub page - source file
[x] Azure Service Bus page - source file
[x] Baidu page - source file
[x] Binary Sensor page - source file
[x] Browser page - source file
[x] BT Home Hub 5 page - source file
[x] Calendar page - source file
[x] Camera page - source file
[x] Unify Circuit page - source file
[x] Cisco IOS page - source file
[x] Cisco Mobility Express page - source file
[x] Cisco Webex Teams page - source file
[x] CityBikes page - source file
[x] Clickatell page - source file
[x] ClickSend SMS page - source file
[x] ClickSend TTS page - source file
[x] Climate page - source file
[x] Cloudflare page - source file
[x] Concord232 page - source file
[x] Configuration page - source file
[x] Configurator page - source file
[x] Conversation page - source file
[x] Counter page - source file
[x] Cover page - source file
[x] Datadog page - source file
[x] DD-WRT page - source file
[x] Remote Python Debugger page - source file
[x] Default Config page - source file
[x] Demo page - source file
[x] Device Automation page - source file
[x] Presence-based Lights page - source file
[x] Device Tracker page - source file
[x] Dialogflow page - source file
[x] Discord page - source file
[x] Discovery page - source file
[x] Dlib Face Detect page - source file
[x] Dlib Face Identify page - source file
[x] Downloader page - source file
[x] Duck DNS page - source file
[x] Edimax page - source file
[x] EDL21 page - source file
[x] Emoncms History page - source file
[x] Facebook Messenger page - source file
[x] Facebox page - source file
[x] Fan page - source file
[x] Feedreader page - source file
[x] FFmpeg page - source file
[x] FFmpeg Motion page - source file
[x] FFmpeg Noise page - source file
[x] Flo page - source file
[x] Flock page - source file
[x] Flux page - source file
[x] Free Mobile page - source file
[x] FreeDNS page - source file
[x] AVM FRITZ!Box page - source file
[x] Home Assistant Frontend page - source file
[x] P5 FutureNow page - source file
[x] Geolocation page - source file
[x] Gitter page - source file
[x] Growl (GnGNTP) page - source file
[x] Goalfeed page - source file
[x] Goal Zero Yeti page - source file
[x] Google Assistant page - source file
[x] Google Cloud Platform page - source file
[x] Google Domains page - source file
[x] Google Pub/Sub page - source file
[x] Google Translate Text-to-Speech page - source file
[x] Graphite page - source file
[x] Group page - source file
[x] Elexa Guardian page - source file
[x] Google Hangouts page - source file
[x] Hikvision page - source file
[x] History page - source file
[x] Rogers Hitron CODA page - source file
[x] Home Assistant Core Integration page - source file
[x] HTML5 Push Notifications page - source file
[x] Huawei Router page - source file
[x] Humidifier page - source file
[x] Antifurto365 iAlarm page - source file
[x] Image page - source file
[x] Image Processing page - source file
[x] Input Boolean page - source file
[x] Input Datetime page - source file
[x] Input Number page - source file
[x] Input Select page - source file
[x] Input Text page - source file
[x] Intent Script page - source file
[x] International Space Station (ISS) page - source file
[x] Joaoapps Join page - source file
[x] Keba Charging Station page - source file
[x] Keenetic NDMS2 Routers page - source file
[x] Keyboard page - source file
[x] Kira page - source file
[x] Konnected.io page - source file
[x] LaMetric page - source file
[x] LANnouncer page - source file
[x] LIFX Cloud page - source file
[x] Light page - source file
[x] Linksys Smart Wi-Fi page - source file
[x] LlamaLab Automate page - source file
[x] Lock page - source file
[x] Logbook page - source file
[x] Logentries page - source file
[x] Logger page - source file
[x] OpenWRT (luci) page - source file
[x] Mailbox page - source file
[x] Mailgun page - source file
[x] Manual page - source file
[x] Manual MQTT page - source file
[x] Map page - source file
[x] MaryTTS page - source file
[x] Mastodon page - source file
[x] Matrix page - source file
[x] Media Extractor page - source file
[x] Media Player page - source file
[x] Media Source page - source file
[x] Meraki page - source file
[x] MessageBird page - source file
[x] Microsoft Text-to-Speech (TTS) page - source file
[x] Microsoft Face page - source file
[x] Microsoft Face Detect page - source file
[x] Microsoft Face Identify page - source file
[x] Mikrotik page - source file
[x] Mobile App page - source file
[x] Mochad page - source file
[x] Microsoft Teams page - source file
[x] Mycroft page - source file
[x] Namecheap FreeDNS page - source file
[x] Notifications for Android TV / FireTV page - source file
[x] Nmap Tracker page - source file
[x] No-IP.com page - source file
[x] NOAA Tides page - source file
[x] Notifications page - source file
[x] Notify.Events page - source file
[x] Home Assistant Onboarding page - source file
[x] ONVIF page - source file
[x] OpenALPR Cloud page - source file
[x] OpenALPR Local page - source file
[x] OpenCV page - source file
[x] OpenGarage page - source file
[x] OPNSense page - source file
[x] Orvibo page - source file
[x] Osramlightify page - source file
[x] OwnTracks page - source file
[x] Custom Panel page - source file
[x] iframe Panel page - source file
[x] Persistent Notification page - source file
[x] Person page - source file
[x] Pico TTS page - source file
[x] Ping (ICMP) page - source file
[x] Plant Monitor page - source file
[x] Prometheus page - source file
[x] Prowl page - source file
[x] Proximity page - source file
[x] Camera Proxy page - source file
[x] PTVSD - Python Tools for Visual Studio Debug Server page - source file
[x] Pushover page - source file
[x] Pushsafer page - source file
[x] Python Scripts page - source file
[x] QR Code page - source file
[x] Quantum Gateway page - source file
[x] QVR Pro page - source file
[x] QwikSwitch QSUSB page - source file
[x] Radarr page - source file
[x] Recorder page - source file
[x] Remember The Milk page - source file
[x] Remote page - source file
[x] RFLink page - source file
[x] RFXCOM RFXtrx page - source file
[x] Rocket.Chat page - source file
[x] AWS Route53 page - source file
[x] RSS Feed Template page - source file
[x] Safe Mode page - source file
[x] Scenes page - source file
[x] Scripts page - source file
[x] Search page - source file
[x] SendGrid page - source file
[x] Sensor page - source file
[x] Shell Command page - source file
[x] Shelly page - source file
[x] shiftr.io page - source file
[x] Shopping List page - source file
[x] Signal Messenger page - source file
[x] Simplepush page - source file
[x] Sinch SMS page - source file
[x] Sky Hub page - source file
[x] Slack page - source file
[x] Salda Smarty page - source file
[x] SMTP page - source file
[x] Snips page - source file
[x] Space API page - source file
[x] Splunk page - source file
[x] SQL page - source file
[x] Simple Service Discovery Protocol (SSDP) page - source file
[x] StatsD page - source file
[x] Speech-to-Text (STT) page - source file
[x] Sun page - source file
[x] Swisscom Internet-Box page - source file
[x] Switch page - source file
[x] Synology Chat page - source file
[x] Synology SRM page - source file
[x] Syslog page - source file
[x] System Health page - source file
[x] System Log page - source file
[x] Tags page - source file
[x] Tank Utility page - source file
[x] Telegram page - source file
[x] ThingSpeak page - source file
[x] Thomson page - source file
[x] Timer page - source file
[x] Tomato page - source file
[x] Honeywell Total Connect Alarm page - source file
[x] Text-to-Speech (TTS) page - source file
[x] Twilio page - source file
[x] Twilio Call page - source file
[x] Twilio SMS page - source file
[x] Twitter page - source file
[x] Ubee Router page - source file
[x] OpenWrt (ubus) page - source file
[x] Universal Media Player page - source file
[x] UPC Connect Box page - source file
[x] Updater page - source file
[x] Vacuum page - source file
[x] Vera page - source file
[x] VeSync page - source file
[x] VoiceRSS page - source file
[x] Water Heater page - source file
[x] IBM Watson IoT Platform page - source file
[x] IBM Watson TTS page - source file
[x] Weather page - source file
[x] Webhook page - source file
[x] Home Assistant WebSocket API page - source file
[x] Belkin WeMo page - source file
[x] WiLight page - source file
[x] World Tides page - source file
[x] Jabber (XMPP) page - source file
[x] Yale Smart Living page - source file
[x] Yamaha Network Receivers page - source file
[x] Yamaha MusicCast page - source file
[x] Yandex Transport page - source file
[x] Yandex TTS page - source file
[x] yesss! SMS page - source file
[x] Zero-configuration networking (zeroconf) page - source file
[x] Zone page - source file

dasadi commented 3 years ago

@frenck What about internal integrations like "Alarm Control Panel" or "Alert"? From my understanding they are internal, which means they shouldn't have an associated IoT class. But in the list quite a few inegrations are internal and I am wondering what to do about them?

ZuluWhiskey commented 3 years ago

Out of interest, what is the idea with integrations like climate where the IoT class would depend on the device you're interfacing with? Or as it's an internal integration does it fall into the same category as (for example) Zone?

MatejMecka commented 3 years ago

I can't find Goal Zero Yeti, all the pages lead to a 404

frenck commented 3 years ago

@MatejMecka 0.116 😉 Will be available after today

MatejMecka commented 3 years ago

Ahh, ok ;) Can't wait

akubak commented 3 years ago

@frenck What about internal integrations like "Alarm Control Panel" or "Alert"? From my understanding they are internal, which means they shouldn't have an associated IoT class. But in the list quite a few inegrations are internal and I am wondering what to do about them?

@dasadi I asked the same thing in the Discord server and he said to use ha_iot_class: ~ for anything that doesn't have a class by itself, like a light or sensor. It's either that or ha_iot_class: Calculated if something gathers input from sensors and then calculates a state, which would apply to some of the alarm components.

home-assistant / home-assistant.io