# OpenIntent

OpenIntent is an [open-source](https://github.com/google/openintent), community-developed data schema that describes wireless network designs. The primary purpose of OpenIntent is to deploy network equipment to any network infrastructure, regardless of which tool was used to design the network.

Hamina Network Planner can both export and import OpenIntent schema in the form of a `.zip` file. While the original purpose of the schema is to describe the network for deployment, it can also be used for general-purpose project importing, exporting, and project data manipulation.

You can use Import/Export OpenIntent to:

* Back up projects outside of Hamina
* Share a project with other users, outside of Hamina
* Export the project with use with another design tool 😭
* Import a project from another design tool 😁
* Move design projects from Hamina instance to another
* Programmatically extract data from the project
* Programmatically add data to the project

{% hint style="info" %}
Since the purpose of OpenIntent is to describe a network design for the purposes of deployment, it does not include site survey data or network measurements. Site survey data is outside the scope of the OpenIntent development project.
{% endhint %}

## Support Matrix

Hamina Network Planner, for Import and Export, supports a subset of OpenIntent's capabilities. In rarer cases, OpenIntent does not support Hamina Network Planner's capabilities. As a result, some project elements are lost when a project is exported from Hamina, or will not be included on import from Hamina.

{% hint style="warning" %}
This table only considers OpenIntent 2.0. It does not include OpenIntent 1.0, and OpenIntent 1.0 support is not documented in the Hamina knowledgebase.
{% endhint %}

|                                  | Export                                        | Import                                        |
| -------------------------------- | --------------------------------------------- | --------------------------------------------- |
| Country                          | ❌ <sup>Not supported in schema</sup>          | ❌ <sup>Not supported in schema</sup>          |
| Maps                             | ✅                                             | ✅                                             |
| Scale                            | ✅                                             | ✅                                             |
| GPS Coordinates                  | ❌                                             | ❌                                             |
| Home Marker                      | ❌                                             | ❌                                             |
| Map Notes                        | ❌ <sup>Not implemented in Hamina</sup>        | ❌ <sup>Not implemented in Hamina</sup>        |
| In/Out of Scope Zones            | ✅                                             | ✅                                             |
| Capacity Zones                   | ❌                                             | ❌                                             |
| **Walls**                        |                                               |                                               |
| Locations                        | ✅                                             | ✅                                             |
| Color                            | ✅                                             | ✅                                             |
| Material Type                    | ✅                                             | ✅                                             |
| Top height from floor            | ✅                                             | ✅                                             |
| Bottom height from floor         | ✅                                             | ✅                                             |
| Fill Top and Bottom              | ✅                                             | ✅                                             |
| Transparency in 3D               | ❌ <sup>Not supported in schema</sup>          | ❌ <sup>Not supported in schema</sup>          |
| **Attenuating Objects**          |                                               |                                               |
| Attenuating Objects              | ❌ <sup>Not implemented in Hamina</sup>        | ❌ <sup>Not implemented in Hamina</sup>        |
| **Multifloor and Raised Floors** |                                               |                                               |
| Floor Alignment                  | ❌                                             | ❌                                             |
| Floor Height                     | ❌                                             | ❌                                             |
| Sloped and Raised Floors         | ❌                                             | ❌                                             |
| **Access Points**                |                                               |                                               |
| Location                         | ✅                                             | ✅                                             |
| Make and Model                   | ✅                                             | ✅                                             |
| Color                            | ✅                                             | ✅                                             |
| Name (Resolved)                  | ✅                                             | ✅                                             |
| Name (Unresolved)                | ❌  <sup>Name exported in resolved state</sup> | ❌                                             |
| Height                           | ✅                                             | ✅                                             |
| Mounting Type                    | ❌ <sup>Not supported in schema</sup>          | ⚠️ <sup>Populated with AP model default</sup> |
| Direction (Azimuth)              | ✅                                             | ❌ <sup>Not implemented in Hamina</sup>        |
| Downtilt (Elevation)             | ✅                                             | ❌ <sup>Not implemented in Hamina</sup>        |
| Channel                          | ✅                                             | ✅                                             |
| Transmit Power                   | ✅                                             | ✅                                             |
| MAC and Serial Number            | ❌                                             | ❌                                             |
| Connected via Ethernet           | ✅ <sup>Resolves to static setting</sup>       | ✅                                             |
| Power allocation from switch     | ❌                                             | ⚠️ <sup>Populated with AP model default</sup> |
| **Wired Infrastructure**         |                                               |                                               |
| Switches                         | ✅                                             | ✅                                             |
| Total Ports                      | ❌                                             | ❌                                             |
| Power Budget                     | ❌                                             | ❌                                             |
| Routers, IDFs, MDFs              | ❌                                             | ❌                                             |
| Cables                           | ❌                                             | ❌ <sup>Calculated at import</sup>             |
| Cable Trays                      | ❌ <sup>Not supported in schema</sup>          | ❌ <sup>Not supported in schema</sup>          |
| Cable Risers                     | ❌ <sup>Not supported in schema</sup>          | ❌ <sup>Not supported in schema</sup>          |