Homey Apps SDK
๐Ÿ“– Apps SDK Reference๐ŸŒ Web API๐Ÿ›  Developer Tools
  • Welcome to the Apps SDK documentation ๐Ÿ‘‹
  • The Basics
    • Getting Started
      • Homey CLI
    • App
      • Manifest
      • Internationalization
      • Permissions
      • Persistent Storage
    • Drivers & Devices
      • Pairing
        • System Views
          • Devices List
          • Add Devices
          • OAuth2 Login
          • Credentials Login
          • Pincode
          • Loading
          • Done
        • Custom Views
      • Capabilities
      • Energy
      • Settings
      • Best practices
        • Lights
        • Window coverings
        • Battery status
    • Flow
      • Arguments
      • Tokens
    • Widgets
      • Settings
      • Styling
      • Debugging
  • Wireless
    • Wi-Fi
      • Discovery
    • Bluetooth LE
    • Z-Wave
    • Zigbee
    • 433 MHz
    • Infrared
    • Matter
  • Cloud
    • OAuth2
    • Webhooks
  • App Store
    • Publishing
    • Guidelines
    • Verified Developer
    • Updating
  • Advanced
    • Custom Views
      • App Settings
      • Custom Pairing Views
      • HTML & CSS Styling
    • Web API
    • Images
    • LED Ring
    • Homey Compose
  • Guides
    • Homey Cloud
    • Breaking Changes
    • Tools
      • Bluetooth LE
      • Zigbee
      • TypeScript
    • Using ESM in Homey Apps
  • Upgrade Guides
    • Homey v6.0.0
    • Upgrading to SDK v3
      • Zigbee Apps
    • Device Capabilities
Powered by GitBook
On this page
  • ๐Ÿš€ Getting Started
  • ๐Ÿ‘ฅ Community

Was this helpful?

Welcome to the Apps SDK documentation ๐Ÿ‘‹

Learn how to build great apps that run on Homey.

NextGetting Started

Last updated 1 year ago

Was this helpful?

Homey is a smart home platform that connects devices from various brands & technologies in one unified experience. Homey owners can control their devices in the Homey mobile & web app, create automations called Flow, learn their energy usage with Homey Energy and view charts with Homey Insights.

The Homey Apps SDK enables developers to create apps that run on Homey. An app for Homey is a bundle distributed through the , or installed by . These apps run local on Homey, similar to an iPhone or Android device.

With the Homey Apps SDK your app can extend Homey by adding new and create new , among other things. Additionally, your app can transmit and receive wireless signals, such as , , , , and .

๐Ÿš€ Getting Started

To get started with your first Homey app, head over to

๐Ÿ‘ฅ Community

  • Questions? Ask them on with the homey tag.

  • Please report any issues you find in the .

Upgrading from Apps SDK v2

This website refers to SDK Version 3 of the Homey Apps SDK. While we encourage maintainers to , documentation for Apps SDK v2 .

Node.js
Homey App Store
Homey CLI
Devices
Flow cards
Wi-Fi
Zigbee
Z-Wave
433 MHz
Bluetooth LE
Infrared
Getting Started ยป
Stack Overflow
Apps SDK Issue Tracker
upgrade their app
is still available