Repository navigation
Templates and Exchanger
TEF means The Exchanger File. Device Capabilities uses TEFs to exchange Flow definitions and Advanced Virtual Device templates between Homey users.
- Post app and Flow questions in the Device Capabilities support topic.
- Post an AVD template in Share Your Device.
- Post a Flow template in The Flow Exchange(r).
- The HCS Share Your Device topic and HCS Flow Exchange topic allow templates involving Homey Community Store apps. The standard Share Your Device topic is for Athom Store apps.
The topics include other language editions; see References.
- Open the AVD's repair/settings screen.
- Choose Open Share Your Device.
- Select whether to include icons and associated Flows.
- Create the TEF.
- Use Post Template to open the appropriate forum topic with a prepared post.
- Add a clear title and short explanation, include a screenshot if useful, and paste the TEF in a preformatted code block.
The community post should explain the purpose of the AVD and identify required apps or assumptions. Never include credentials, tokens, or private account data in a template.
- Open The Flow Exchange(r) from the Device Capabilities app settings.
- Choose the export workflow and select one or more Flows.
- Create the TEF and choose Post Template.
- In the forum reply, paste the prepared description and TEF into a preformatted code block.
- Explain the required devices, apps, tags, and any setup the importer must perform.
- Copy the TEF from the template post.
- Paste it into the import area under The Flow Exchange(r) in app settings.
- Choose Read Flows to inspect what the file references.
- Replace the creator's devices, users, variables, app references, and other objects with suitable objects on your Homey, or remove references you do not need.
- Review the generated content before using it. The documented workflow produces a Homey API Playground script to create the Flow(s).
- If you are comfortable with the script and its references, open the official Homey API Playground, paste it, and run it.
- Verify the created Flow(s) and adjust any settings that are Homey-specific.
The import tool helps map references, but it cannot make a template's devices, apps, or logic identical to yours. A Flow that imports successfully may still need editing.
Templates can be selected while creating an AVD and through the app settings or AVD repair workflow. Review the template description, required apps, fields, and icons before applying it. If the TEF includes Flows, follow the app's generated import instructions to create those Flows as well; do not assume every template applies device configuration and Flows in one automatic step.
The discussion's AVD example demonstrates creating a multi-control "Living Room" device for media, curtains, and buttons. A separate example shows a three-room light-switch AVD connected to Flows.
- Templates can refer to apps that are not installed on your Homey. Install required apps or remove/replace those references.
- The standard and HCS template topics differ in which store apps their templates may use.
- Names and IDs in an exported Flow belong to the creator's Homey; map them to your own devices and variables.
- Read and understand generated API Playground code before executing it.
- Start by importing into a non-critical setup, then verify every created Flow and device.
- Keep a backup of important Flow logic before replacing or importing shared configurations.
Support development - If Device Capabilities is useful to you, you can support its
continued development through GitHub Sponsors,
Patreon,
PayPal, or
bunq.
Thank you!