Skip to main content

Production Information

The Legacy IDE is now no longer available. It has been replaced by impCentral™

The Dashboard

When Electric Imp Customers (entities who have a commercial relationship with Electric Imp) sign in to the IDE, they are presented with the Dashboard, a visual readout of production activity related to their account. The Dashboard is not available to holders of free Electric Imp accounts.

In Dashboard mode, the IDE presents a series of information readout widgets in the Workspace. Currently, there are three widgets, but more will be added in future.

  • Production Data Usage This widget displays the bandwidth consumed by your production devices in the past 30 days. The headline figure is the total volume of data sent by production devices to their agents in the Electric Imp impCloud™ and received by those same devices. The widget also lists the upload and download tallies separately.
     

  • Factory Devices This widget lists the device IDs of factory devices assigned to your production models that have connected to the impCloud recently, plus production devices under test that have run factory firmware.
     

  • Production Devices This widget lists production device activity on an all-time basis, including the number of devices blessed during that period and the number that were activated by end-users.
     

Production Logging

Devices that have been blessed for end-use do not appear in the IDE in the same way that development devices do. Logging information generated by their application firmware is not transmitted back to the Electric Imp impCloud. To allow you to temporarily view log entries from a selected blessed device for the purpose of customer support, use the IDE’s production logging feature. This is accessed from the IDE Tab Bar’s ‘Production Logs’ tab.

What You Need to Use Production Logging

Production Logging must be enabled manually and can only enabled for up to five specific devices. To do this, you will need a device’s ID. Production devices do not appear in the IDE, so you will need to obtain a given device’s ID by other means.

For example, your BlinkUp™ SDK-based mobile app will receive the device ID of each production device it configures. Your app can present this ID among the information you provide to end-users when they seek techical support contact details. This allows your technical support staff to ask the end-user for their device’s ID.

What Production Device Logs Will You See?

When enabling production logging on a device for the first time, no historical logs will displayed. You will only see log entries posted after production logging was enabled for that device. Until production logging is enabled, production devices do not send log messages to the server even if their production model contains code that calls server.log() or server.error(). Log entries are not retained by the device.

Devices which are offline when production logging is enabled will not begin posting logs until they subsequently connect to the impCloud. Again, no prior log entries are retained, even from the period between production logging being enabled and the device connecting to the impCloud.

How to Use Production Logging

In the IDE’s Tab Bar, click on the ‘Production Logs’ tab. A ‘New Device Log’ panel will appear in the Workspace:

Enter a device ID into the space provided. Click on the blue zoom arrows to expand the panel to the full width of the window if you wish. Click on the ‘Submit’ button to begin logging. Click on the 'X' icon to stop logging for this device.

The ‘Show Factory Logs’ checkbox allows you to view log messages from devices used in a factory environment. These devices, when first configured, are considered development devices and may be used as such, perhaps to test factory firmware. Factory logs are stored separately from other types of logs, so checking this box is required to view them.

Your support staff can now ask the end-user to power-cycle their device and view the messages posted by the device as it restarts, connects to the impCloud and begins operation.

Using Production Logging to observe a device’s behavior presents you with all the log entries you might expect to see in the IDE log: device start-up, connection and disconnection times; errors generated by application firmware code; other errors, such as recorded WiFi outages; and any messages posted by the server.log() method.

Retaining Log Information

Press the log’s ‘Select All’ button to auto-highlight the current log entries so they can be copied and pasted into a support incident record.

To reduce clutter and help you focus on future log entries, click on the ‘Clear Log’ button. This will hide existing log entries. It will not delete existing log entries, which you will still be able to view if you re-enter the device ID into the Production Logging interface at a later time.

Multiple Devices

Production Logging supports viewing up to five devices at any one time.

If you need to view the log of a sixth device, you will first need to click the white-on-red cross icon in the top left corner of in one of the existing log read-outs and click on ‘Yes’ when prompted to remove that device from the screen:


 

Production Devices in the Factory

Clicking on the ‘choose recent factory device’ link in the ‘Production Device Logs’ panel allows you to activate and inspect logs posted by production devices while they are within the factory. This allows you to view logs posted during the factory process: once your factory firmware has begun running on the production device and while the device is tested and then blessed:

The link presents a list of the 20 devices which most recently passed along the assembly line, connected to the factory network, and download and ran the factory firmware. They are listed by their device ID — click on a device’s ‘View Log’ link to examine log entries posted by the factory firmware on that device:

Devices are listed indefinitely — or until they are pushed out by more recent factory devices. Once a production device has been blessed and downloads its assigned production model (its application firmware), factory logging will cease.

The ‘Report’ Tab

The ‘Report’ Workspace tab provides statistical data for each model you have deployed to devices in the field. To access the ‘Report’ tab, move your mouse pointer over a production model, then click on the ‘code’ icon under the ‘Actions’ column. The model’s code view will appear, and you’ll see the ‘Report’ tab over on the far right side, alongside ‘Factory’ (which takes you to the model’s Factory settings.

The ‘Report’ tab presents the following charts:

  • Blessed — The number of devices that have been blessed in the factory.
  • Activated — The number of devices which have been activated by end-users with BlinkUp™.
  • Active — The number of unique devices active in a month, ie. those which are powered on and actively in communication with the impCloud.

These charts are updated every 24 hours.


Back to the top or Back to the Contents