Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: update for 1.0.0


Warning
titleCompatibility

The content on this page has not been updated to be consistent with the 1.0 release of the pico engine. 

The My Picos page will be at  httpThe main page will be at http://localhost:3000/#/ , assuming that you have used the default port and are running the pico-engine on your own machine.

Overview of all your picos

When you visit this page, you will see a rounded rectangle which represents your root pico.

If you have created child picos, they will also be visible on this page, each joined to its parent pico by a solid black 3px line. Each pico can be dragged to move it to a different location on the canvas. You can also drag a corner to reshape and resize it.

Image RemovedImage Added

More detail for a single pico

A single left mouse click on the name of the rounded rectangle pico will open it up for a more detailed look at the properties of your root pico.

Image RemovedImage Added

UI tabs

The information about the pico is organized with tabs.

About tab

The About tab shows the pico's internal identifier (ID), its secret engine ui event channel identifier (ECI), and its name. Notice that the secret ECI "is a non revocable path into your pico and should be treated as a shared secret between the pico and any application using it in this pico's Event-Query API. Do not disclose it or check it into a repository like GitHub. Best practice is to create a new revocable ECI for every usage." When a pico is created, it is given a system self ECI and an engine ui ECI. Creating a new ECI is done in the Channels tab, described below.

This tab allows you to change a pico's display name , and/or color. Make changes to the text box and/or the color picker, and then send the pico the visualengine_ui:updatebox event by clicking on the Save button provided.

This tab also shows the parent pico if it has one. The root pico has no parent.

...

Finally, there is a form which you can use to manually create a direct child pico. Fill in the display desired name and choose a color, then send the pico the wranglerengine_ui:new_child_request event by clicking on the Add button provided. After you do so, the UI will refresh to show the new child pico in the list of children.

Rulesets tab

This tab allows you to see and control which rulesets are installed in the pico.

Image RemovedImage Added

It begins with a list of the rulesets currently installed in the pico. A newly created pico will come with three rulesets installed.

  • io.picolabs.subscriptionpico-engine-ui which allows the pico to establish a two way relationship with another picopicos to interact with the UI. This ruleset can cannot be deleted if not needed.
  • io.picolabs.visual_paramssubscription which allows picos to interact with the UIthe pico to establish a two way relationship with another pico. This ruleset cannot can be deleted if not needed.
  • io.picolabs.wrangler which is a kind of operating system for the pico, described more fully in the Wrangler Operating System pages page. This ruleset cannot be deleted.

A checkbox to the left of each ruleset identifier (RID) when checked will allow you to see the entity variables of this ruleset which are stored in the picomore information about this ruleset, and buttons to "flush" and "uninstall" the ruleset. You will see the URL from which the ruleset was installed. If you know the content of the resource at that URL has changed, you should click the "flush" button. When you do so, you will see that its hash changes, along with the "Last flushed" date.

There is also an input box that you can use to install a ruleset from a raw KRL source code URL. In this case, if the ruleset is not already registered with the pico-engine, that will be done firstThe ruleset will be compiled, and then if there are no errors, the ruleset will be installed in the pico.

In the next section, "Available Rulesets," there is a list of rulesets which are registered in the pico engine, but not installed in the pico. If it makes sense, you can select one of these and install it into the pico.

The final section is a link to the Engine Rulesets page, which allows you to make quick edits to any ruleset registered with the pico-engine.

Channels tab

This tab allows you to manage the channels owned by this pico.

Image RemovedImage Added

The first section shows a list of all of the pico's channels. Each channel has properties, five of which are shown in this page.

...

an identifier (ECI) and tags, and policies. Clicking on the checkbox beside the ECI shows you the policies for the channel. See the Managing Channels page for an in-depth discussion of channels.

Channels can be deleted (with one the exception of family channels). Deletion cannot be undone, so be careful. Doing so revokes the ability of outside applications to use the ECI again.

Normally, the admin secret ECI is never used by outside applications. Instead you use the input boxes of the final section to create new channels for separate purposes.

Policies tab

This tab allows you to see all of the policies in effect in the pico-engine.

Image Removed

You may install a ruleset to explore these if you wish.

Subscriptions tab

The Subscriptions tab shows the list of subscriptions in which the pico participates. Checking the box shows more detail about the subscription. There is a set of input boxes on this tab to allow you to initiate subscription requests, and respond to pending subscription requestsThe form at the bottom of the tab allows you to specify tags, an event policy, and a query policy. Clicking on the "Add" button creates a new channel for your pico.

Logging tab

This tab allows you to see detailed logging information concerning events and queries sent to the pico within the last twelve hours.

Image RemovedImage Added

This tab requires a ruleset to be installed in the pico. You may do this by clicking on the link.

Image Removed

With the io.picolabs.logging ruleset installed in the pico, this tab will let you see the latest "episodes" transactions (either events or queries) which the pico has processed. Click on the checkbox to see detailed logging. To see more episodes, change the number in the box and click on the Logging tab again.

See also the Developer UI -- Logging tab page.

Testing tab

The Testing tab displays a list of rulesets which are installed in the pico.

Image Removed

Checking Image Added

You first choose the ECI that you want to use, then check the box beside a ruleset RID opens to open a list of forms which will permit you to supply arguments and send queries and/or events to the pico. The results of these queries and events will be displayed on the right side of the tab's display area.

Subscriptions tab

The Subscriptions tab shows the list of subscriptions in which the pico participates. Checking the box shows more detail about the subscription. There is a set of input boxes on this tab to allow you to initiate subscription requests, and respond to pending subscription requests.