Getting Started Devs

Getting Started (Developers)

Ramses Extras is build 'on top' of Ramses RF and makes use of it's assets. Therefore Ramses RF should be installed beforehand.

Ramses Extras is build with a feature-centric architecture. Each feature has it's own folder with all the files and logic separated from the rest of the integration. Also frontend files are stored within this folder and will be deployed to the HA config/www folder. The framework itself provides basic helpers and classes that will help speed up new development.

The hello world feature can be used as a template/example for future features.

Features can implement components as needed:

• automation
• services
• entities + HA platforms (sensor/switch/number/binary_sensor)
• cards (frontend)
• WebSocket commands (for cards and integrations)
• feature-specific config flow step (optional)

A lot of these components or assets needed for a feature are defined in their local const.py files.

Understand the structure

High-level layers:

• Home Assistant integration wrapper (entry point, config flow, services)
• Features (self-contained modules)
• Framework (shared base classes/helpers)
• ramses_cc (device communication)

See also:

• System Architecture
• Framework Foundation

Adding a new feature

See: Feature System

---

Back to: Home

Prev: Getting Started (Users) Next: Feature Catalog