Open a Project

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

Open a Project

In the upper-left of the Startup window, you’ll see a personal greeting. Below your name, you’ll see links to developer documentation, including this Profile Editor User Guide. In the lower-left you’ll see a link for signing out.

In the center of the Startup window, you’ll see a display of your current projects; or if this is your first project, a link to create a new project, and a link to a tutorial.

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. Note that the profile name will be used as your default project name and device type name. You can change these later. Then 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 select the Create subfolder using Profile Name checkbox to have a folder created for you using your new profile name.

New Device Project

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

Project Icon

Open Existing Project. If you’ve previously saved any projects, they will be shown in “panels”, displaying the icons you assigned. If you haven’t assigned an icon yet, a question mark No Icon Assigned for Project will display. Double-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 Project window opens; proceed as you would when creating a new project.

Open Icon

Open/Import Local Project. Click this button 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

Quick Links. Click a link in the left-hand pane to open the developer documentation and other links 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 > New Project to begin a new project.
    • File > Open Project to navigate to and open a saved project.
    • File > Clear List to clear the Startup window of all the displayed projects.
    • File > Clone Project to make a copy of your open project (menu item appears active when you have a project open). If you are defining a new device type with this project, make sure the "profile name" you give it is unique across your projects, a name that you haven’t used before.
    • 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 projects we’ve posted to the aferodeveloper GitHub site. You can use these projects as starting points. To see all the projects we’ve created (not just those explicitly listed in the menu), select the GitHub Repository menu item.
    • 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.
    • With a Profile Editor project open:User Interface
      • The leftmost section of the Profile Editor window 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.

      • The rightmost section, 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.

      • 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.

      • Selected checkboxes and radio buttons are partially filled with orange; deselected checkboxes and radio buttons are filled with dark grey.

      • Selected options have an orange background (“OUTPUT” in the example); deselected options have a black background.