Open a Project

When you launch the Afero Profile Editor, the Startup window appears:

Open a Project

In the upper-right of the Startup window, you’ll see a personal greeting with your username, a link for signing out, and a link to Device History. If you click the Device History link, a window with two tabs will open: one lists Devices (all the devices associated with your developer account) and the other lists Device History (all that’s happened between your device and Afero in the last 24 hours). You can also view this information from the Publish window. Read more about these lists in Publish Your Project.

In the center of the Startup window, you’ll see a group of icons. You will use these to open, create, and import projects, as well as access the developer documentation:

New Icon

New Project. After selecting this option, you’ll first be asked to select which Afero board/module you are using for your project. Then give your new profile a name and navigate to the local working directory holding your Profile Editor projects. You can either use the operating system to create a new, empty folder for your project in the selected working directory, or you can check the Create subfolder using Profile Name checkbox to have a folder created for you using your new profile name.

New Device Profile

When you’re ready, click Create. The Define the Device Type window opens.

Project Icon

Open Existing Project. If you’ve previously saved any profiles, they will be shown as gray hexes holding the icon you assigned; e.g., the lamp, lock, running man, or water drop icons in the illustration above. If you haven’t assigned an icon yet, a question mark No Icon Assigned for Project will display. Click an icon to open the associated project.

Clone Existing Project. If you have a project you’d like to use as a starting point for another, first open the project you want to clone. Then go to the operating system menu bar and select File > Clone Project. The Clone Device Profile window opens; proceed as you would when creating a new project.

Open Icon

Open/Import Local Project. Click this option to open any Afero project that was not saved by your local Profile Editor (typically this means another developer has shared a project with you by sending you a copy).

Documentation Icon

Open Documentation. Click to open the developer documentation in a browser window.

Once you’ve opened a project, you’ll see the Device Type Definition window, described further in Define the Device Type.

Profile Editor User Interface

Before going to the next section, let’s do a quick tour of the Profile Editor UI:

  • The system menu bar contains a few items worth noting. Select:

    • File > Open Project Folder to navigate to and open a saved project.
    • File > Clone Project to make a copy of your current project.
    • View > Account Info to see information about your account: first name, last name, username, and authentication information. This includes your OAuth Client ID and OAuth Client Secret, which you’ll need when working with Afero Cloud API endpoints.
    • Tools > Sample Projects to download some zipped projects. You can use these as starting points.
    • Help > Collect Anonymous Usage Data to toggle this option on or off. Any data collected is anonymous and used only to help us improve the Profile Editor based on how you use it.
  • The leftmost section of the Profile Editor is the Navigation pane. We’ll be working our way down the pane as we create a Profile. To close your current project, simply select Close Project at the bottom of the Navigation pane.

  • You can hide/show the Navigation pane on the left and the Preview pane on the right by clicking the arrows located at the top inside corners of the panes: . They work as toggles, showing/hiding the associated pane.

  • In the upper-right of the window, you’ll see the Discard and Save buttons. These always act on the values in the currently-visible window.

  • Below the Discard and Save buttons is the Preview/Example pane. Depending on what is displaying in the center pane of the window, you may see example views of the mobile app UI, the Modulo board, or UI elements you’re working with.

  • Below the Preview pane is a set of links to relevant developer documentation. When selected, the documentation opens in a browser window or tab.