{"id":3908,"date":"2024-01-28T18:41:16","date_gmt":"2024-01-28T16:41:16","guid":{"rendered":"https:\/\/mummila.net\/nuudelisoppa\/?p=3908"},"modified":"2024-01-28T18:41:16","modified_gmt":"2024-01-28T16:41:16","slug":"notes-as-i-go-my-attempt-to-develop-a-home-assistant-integration-part-1","status":"publish","type":"post","link":"https:\/\/mummila.net\/nuudelisoppa\/2024\/01\/28\/notes-as-i-go-my-attempt-to-develop-a-home-assistant-integration-part-1\/","title":{"rendered":"Notes as I go: my attempt to develop a Home Assistant integration, part 1"},"content":{"rendered":"

Set up Development Environment<\/a> says the “easiest way to get started with development is to use Visual Studio Code with devcontainers”, but I dislike both those things, so I go with Manual Environment<\/a> instead.<\/p>\n

I’m not doing core development or even integration PRs for now, so I don’t need a fork; instead I just git clone --depth 1 https:\/\/github.com\/home-assistant\/core.git<\/code>.<\/p>\n

For the dependencies<\/a>, sudo apt install python3-pip python3-dev python3-venv autoconf libssl-dev libxml2-dev libxslt1-dev libjpeg-dev libffi-dev libudev-dev zlib1g-dev pkg-config libavformat-dev libavcodec-dev libavdevice-dev libavutil-dev libswscale-dev libswresample-dev libavfilter-dev ffmpeg<\/code><\/p>\n

\n

I then try to run script\/setup<\/code>, except that’s not going to work, because it’s not in my path; to call it from the core<\/code> root directory using a relative path, it has to be .\/script\/setup<\/code><\/p>\n

Some python packages get installed, and in the end it craps out with “no such option: –config-settings”. Apparently Python 3.10, which my Ubuntu 22.04 desktop has, is no longer supported<\/a>, so I need to redo all of the above on my laptop (which is running Ubuntu 23.10 with Python 3.11).<\/p>\n

\n

I then try python3 -m script.scaffold integration<\/code>, which is what I’m here for, but it fails with “ModuleNotFoundError: No module named ‘attr'”. Nothing useful comes up on Google, but then I realize I need to source venv\/bin\/activate<\/code> first.<\/p>\n

After I answer the scaffolding questions, the script begins building the scaffold, but that also craps out, this time with “ModuleNotFoundError: No module named ‘numpy'”. pip3 list<\/code> reveals this to be true, so I pip3 install numpy<\/code>.<\/p>\n

I restart python3 -m script.scaffold integration<\/code>, which this time only asks the first question, then (correctly) assumes my previous answers to the others are still valid, and finally generates the scaffolding. Doesn’t tell me where it is, but git status<\/code> shows theres new stuff in homeassistant\/components\/<\/code> and in tests\/components\/<\/code>.<\/p>\n

“The next step is to look at the files and deal with all areas marked as TODO.”<\/p><\/blockquote>\n

\n

I rsync the scaffolding back to my desktop and open __init__.py<\/code> in VSCodium<\/a>. The first TODO says “List the platforms that you want to support.” By default it’s set to LIGHT<\/code>, but my thing is a button, so I go looking for the platform alternatives<\/a>. “There are lights<\/a>, switches<\/a>, covers<\/a>, climate devices<\/a>, and many more<\/a>.”<\/p>\n

The “many more” link goes to an entities introduction page, so I assume the side menu listing of Entities is what I have to choose from. As I said, I’m developing a button, so you’d think, a Button<\/a>, right?<\/p>\n

Of course not:<\/p>\n

“not suitable for implementing actual physical buttons; the sole purpose of a button entity is to provide a virtual button inside Home Assistant.”<\/p>\n

“If you want to represent something that can be turned on and off (and thus have an actual state), you should use a switch entity instead.”<\/p><\/blockquote>\n

I don’t, because mine doesn’t, so no.<\/p>\n

“If you want to integrate a real, physical, stateless button device in Home Assistant, you can do so by firing custom events. The entity button entity isn’t suitable for these cases.”<\/p><\/blockquote>\n

Well, I’d like to fire events, but this only seems to draw further away from what “platform” I need to use for my integration.<\/p>\n

The scaffolding imports Platform from homeassistant.const<\/code>, so I find the Platform<\/code> enumeration in const.py<\/code><\/a>, but it just lists the same entities as the documentation side panel, so I’m out of luck.<\/p>\n

No, wait, Event<\/a> is also listed. So I’ll go with Platform.EVENT<\/code> for now. That means I’ll need to “create a file with the domain name of the integration that you are building a platform for” \u2014 so in this case, event.py<\/code>.<\/p>\n

Actually, Integration File Structure<\/a> says<\/p>\n

“If the integration only offers a platform, you can keep [__init__.py<\/code>] limited to a docstring introducing the integration”.<\/p><\/blockquote>\n

So that means I don’t need any of the __init__.py<\/code> scaffolding?<\/p>\n

\n

Whatever, I’ll take a look at the manifest<\/a> instead.<\/p>\n

Integration type<\/a> was not set up by the scaffolding script (despite the documentation saying it should be set, and becoming mandatory in the future). I’m going to pick device<\/code>, which seems unambiguous, for once.<\/p>\n

Version<\/a> is mandatory, I’ll go with 0.1.<\/p>\n

My button communicates via Bluetooth, and Best practices for this<\/a> says I need bluetooth_adapters<\/code> in my dependencies<\/code><\/a>.<\/p>\n

I’ve used bluetoothctl<\/code> to sniff out what name the device uses, so I’m also defining a local_name<\/code> matcher in a Bluetooth section<\/a>. There’s also connectable<\/code><\/a>, but it defaults to true, which is what it should be for my button.<\/p>\n

In the scaffolding, I’d previously set iot_class<\/code><\/a> to local_polling<\/code>, and I’m going to leave it as such, although for now, I’m treating the button as if didn’t have any state.<\/p>\n

\n

Next, config_flow.py<\/code><\/a>.<\/p>\n

“Discoverable integrations that require no authentication<\/a>” looks useful, so I go back to my laptop, source venv\/bin\/activate<\/code> again, then python3 -m script.scaffold config_flow_discovery<\/code>, and finally rsync the new files (now named EXAMPLE_*<\/code>) back again. The only changed file was config_flow.py<\/code>, which is now substantially smaller, defining mostly just _async_has_devices()<\/code>.<\/p>\n

The only TODO there is “Check if there are any devices that can be discovered in the network.” Spying from one core integration<\/a>, my guess is that _async_has_devices()<\/code> receives a bunch of discovered devices, and should return true only if any of those devices are ones that my integration is actually able to configure.<\/p>\n

Why\/whether this isn’t already handled by the matcher definition in the manifest, I don’t know; I found at least one integration that always returns true<\/a>, with a comment “MQTT is set as dependency, so that should be sufficient.”<\/p>\n

\n

I minimally tweak the MyEvent<\/code> example<\/a> and save it as event.py<\/code>. I think it’s missing at least imports of EventEntity<\/code> and EventDeviceClass<\/code>. Also, there’s a tip about being “sure to deregister any callbacks when the entity is removed from Home Assistant”, so why isn’t that incorporated into the example?<\/p>\n","protected":false},"excerpt":{"rendered":"

Set up Development Environment says the “easiest way to get started with development is to use Visual Studio Code with devcontainers”, but I dislike both those things, so I go with Manual Environment instead. I’m not doing core development or even integration PRs for now, so I don’t need a fork; instead I just git […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-3908","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/mummila.net\/nuudelisoppa\/wp-json\/wp\/v2\/posts\/3908","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/mummila.net\/nuudelisoppa\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/mummila.net\/nuudelisoppa\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/mummila.net\/nuudelisoppa\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/mummila.net\/nuudelisoppa\/wp-json\/wp\/v2\/comments?post=3908"}],"version-history":[{"count":32,"href":"https:\/\/mummila.net\/nuudelisoppa\/wp-json\/wp\/v2\/posts\/3908\/revisions"}],"predecessor-version":[{"id":3940,"href":"https:\/\/mummila.net\/nuudelisoppa\/wp-json\/wp\/v2\/posts\/3908\/revisions\/3940"}],"wp:attachment":[{"href":"https:\/\/mummila.net\/nuudelisoppa\/wp-json\/wp\/v2\/media?parent=3908"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mummila.net\/nuudelisoppa\/wp-json\/wp\/v2\/categories?post=3908"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mummila.net\/nuudelisoppa\/wp-json\/wp\/v2\/tags?post=3908"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}