Resources

To use the Purrmetrix service you will need to get yourself

1) Purrmetrix hardware (minimum a sensor and a gateway unit) and

2) your own Purrmetrix web service account.

If you don’t have any hardware, please get in touch to discuss what you will need. If your hardware has been given to you by someone else, you will need to adopt that hardware into your account. See the section on 'Managing hardware' for more details.

Once you have both hardware and web service, you are ready to begin installation.

Need extra help?

With hardware and web service in your hand your first step is connect the hardware to your webservice.

First, plug the power supply into the gateway and use the Ethernet cable to connect it to a router or other Ethernet socket on your local network. You should see two lights on the back of the gateway beside the Ethernet port – orange is power, green is internet – and a red LED inside the case, between the Ethernet port and the power socket will light up.

Once the gateway is activated, open your web service, where you will see an invitation to connect your gateway (below). Click on Action in the top menu, then pick the ‘adopt a gateway’ link.

You will be prompted to enter the pass phrase on the end of the gateway. Leave the spaces between the words.

Your service should now confirm that your gateway is adopted.

The next step is to wake up your kittens. They are supplied ‘asleep’ to save their battery – if you squeeze the face an LED inside the sensor will flash lazily to show it is asleep. If you then squeeze the face of the kitten four times it will wake up. You can tell it is awake because the LED changes to a faster flash.

Once they are awake, place the kittens near the gateway and hit ‘next’ in the web service. The gateway should now discover all the kittens within range, and they will appear in the library of your account (the top block marked ‘<Your team name> things’). If you can’t see anything in that block, you may need to click on the slider that makes the hardware visible:

If you want to know which kitten is in your hand, simply press the nose and let go, the kitten in the web service will go red and will temporarily appear in the top right corner.

You can now prepare to install your kittens where you need them. But first you will need to be familiar with how to build an analytics view in your web account.

Click here to find out how to build your first analytics view.

Or, click here to check how to get hardware and a web service.

Need extra help?

Now you have connected your hardware to your web service you can build the first view to collect and analyse your data.

In Purrmetrix ‘views’ are the blocks that you use to organise your sensors and carry out an analysis. These can range from something simple like a bar chart or more complex like a dew point analysis.

For most users, the best starting point is a heatmap view. Heatmap views let you locate your sensors in a plan or picture of your building and gives you a great overview of what is happening, highlighting areas and times where you might want to look deeper into the data. They’re also really useful as a record of where sensors are installed.

To build a heat map, open the ‘create view’ menu (see below) and select Graph Heatmap.

1. A new, empty view will open up.
2. Click on the title of the box to change its name. You can now re name the Graph Heatmap.
3. Upload a plan (PNG, JPG, GIF, EPS) by dropping the image on the hot spot.
4. Physically pick up a kitten and identify it. If it isn’t labelled you will need to label it at this point.
5. You can also make a note in the web service of the exact / descriptive location you plan to put the kitten in, by double clicking on the kitten and filling in the notes field (eg ‘under desk 1’).
6. In the web service, drag each kitten to the right location on your image.
7. You can now fix your real kittens in the right location.
8. Your plan will automatically populate with data.

Notes

1. Any images uploaded will be resized to 800 px wide
2. It is possible to zoom in and out along the timeline by dragging and clicking your mouse to the left (to zoom out) or to the right (to zoom in)
3. On any graph you can leave a note that relates to a point in time by double clicking on the x-axis
4. PRO TIP: once you have set up this first view it is helpful to create a project called BACKUP and copy and paste this view into it. This will then keep the record of where you originally installed the sensors.

Need extra help?

With your kittens fixed and the first view set up, there are a range of other views to help you interpret the data.The Purrmetrix web service supports a huge range of analytics views; the full list of views is available below.

Setting up views follows the same steps as with the heatmap:

1. Open ‘create view’ and select the view you want.
2. Once the view opens, drag and drop the kittens you want to analyse into the new view. You can either select the kittens from the heatmap you made in the last step, or from the library block at the top of your project.
3. You can change the title of the view by double clicking on the title
4. Click on the gear icon (see below) to open up the settings panel. Each view has its own settings, for example in the waterfall view you can change what metric your kittens are reporting, link the colour map to your temperature range and put in averages.
5. It’s possible to change the order of views by dragging each view box using its top border.

Notes

To remove kittens from a  view simply drag them to the bottom right and drop them into the bin that appears. They will only disappear from the view you originally selected them, and will remain in location in all others.

If you are moving kittens from one plan view to another they will retain their location on the plan.

It is possible to copy a view, complete with kittens. Open the setting by clicking on the gear icon and click on the copy button at the bottom left. To paste, open the actions menu and click ‘Paste View’ and a new copy will appear at the top of the list of views. This option can be used to lift a view from one project and copy it into a new project.

Need extra help?

Purr’s webservice is a very flexible tool that can support many different types of analyses on data from any location in your project. This can rapidly create a lot of different views, and organising these in a logical fashion will save time and improve performance.

To do this we use ‘projects’. A project, for Purr, can be any group of views that have a common theme. Some examples:

• All the views for each building in an estate
• All the views for refrigeration units where there is some question mark over performance
• A group of views set up for the north end of several greenhouses

To set up a project:

1. Click on the create new project button near the top of the page.
2. Select the kittens you want from the library, or paste an existing view in (see ‘working with views‘) to automatically import all the hardware you want to associate with that view
3. Name your project using the project dialogue box

Notes

For sensitive analyses, projects can be locked as private to one user only.

We recommend creating a Backup project from your first installation. This can be used to keep copies of any heatmaps you create and thus is a safe record of where sensors are installed.

Need extra help?

Once you have collected the hardware to your Purr account and set up your first view, there are many views available that can help you make sense of the data you are collecting.

Each view has its own localised settings, however the basic process for setting up the views is similar: open the view, select the kittens that need to contribute to the view, drag and drop them into the view box, adjust the settings in the view to give you the information you are interested in.

To demonstrate, we shall set up a ‘Graph and Heatmap’ view:

1. Click on the ‘graph and heatmap’ icon to open up the view.
2. Upload a plan or image to locate the kittens on.
3. Select the kittens you want to contribute to that view. You can either select kittens from the ‘library’ block at the top of the views, or direct from another view.
4. Drag and drop those kittens into the new view.
5. Click on the title of the view to give it a new name and to set it up with the right characteristics. In this case you can set the range of the heatmap’s colours to reflect the temperature range you are interested in.
6. You can now use the date picker on the graph to select the time that interests you.

Sharing views

If you want to share the results of a view without having to give account access. Purr’s views can be shared publicly, either a simple web page, or as an object embedded in a dashboard using iframes.

To share a view:

1. Set up the view and select the time frame that you wish to share.
2. Click on the view title to bring up the view dialogue.
3. Click on the embeddable link for this view. It will open a new page.
4. Copy and paste the URL for this new page to share with colleagues or place in an iframe for a dashboard

Notes

To remove kittens from a  view simply drag them to one side and drop them. They will only disappear from the view you originally selected them, and will remain in location in all others.

If you are moving kittens from one plan view to another they will retain their location on the plan.

It is possible to copy a view, complete with kittens. Open the view dialogue by clicking on the view name and click on the copy button at the bottom left. To paste, open the actions menu and click ‘Paste View’ and a new copy will appear at the top of the list of views. This option can be used to lift a view from one project and copy it into a new project.

At this point, not all views support linking to a preselected time view. The default is to show the last hour, day or week.

Need extra help?

Purr’s system supports a number of features to make it easier to manage your hardware.

If you have an unlabelled kitten, you can find it on the webservice by simply pressing the kitten’s nose. Its LED should flash, and after a short – typically 10 second – delay – it should appear red on the plan. It will also appear in the top right hand corner of your page.

To understand more about the what kitten is doing what, double click on it. The dialogue box will show you name, ID, notes on location and which views the kitten is being used in.

Adding more hardware to an existing account.

If you have purchased more gateways, you will need to verify them to your account:

1. Go to actions in the top menu bar
2. Click on ‘adopt a gateway’
3. Type in the pass phrase printed on the end of the gateway

Any kittens you have purchased can be collected by gateways you own, by listening out for them. You can either click the ‘gather kittens’ button that pops up after the gateway is adopted or :

1. Go to the ‘actions’ box and click ‘gather kittens’.
2. The gateway will listen out for ‘kittens in the wild’ which will appear in a new box.
3. Transfer these ‘kittens in the wild’ into your account.

Remember that, before you add more kittens to your account, you need to purchase sufficient subscriptions to support the extra kittens.

It is also possible to receive kittens from another account, if their owner gives them away:

Giving away kittens

If you are a user in more than one account, it is possible to give away kittens or gateways from one account to another. To do so:

1. Select the hardware you want to give away.
2. Click on the ‘actions’ box and select ‘Give away stuff’.
3. When the ‘Give away stuff’ dialogue opens, select the account you want it to go to.
4. The stuff will arrive in the new account library, ready for use.

Alternatively, you can also set stuff free, so that it can be claimed by any gateway that hears it, regardless of who that gateway belongs to. To do this:

1. Follow steps 1-3 above, but select ‘Set stuff free’ in the ‘Give away stuff’ dialogue box.
2. A user of the recipient account must go to the ‘actions’ box and click ‘gather kittens’.
3. The gateway will listen out for ‘kittens in the wild’ which will appear in a new box.
4. Transfer these ‘kittens in the wild’ into your account.

Click here to understand more about organising your views

You can also create kittens that represent data from other sources. Click here to look at how to import data like this.

Need extra help?

There are all sorts of reasons why you might want to share data with people and services outside the Purrmetrix web account, so we have provided several tools to help you. Depending on your application you might want to:

1. Share a view with an external audience
2. Export some data for analysis offline
3. Integrate data with another software service using an API

Sharing a view with an external audience

For Basic and Pro users, all views can be ‘published’: turned into a unique URL that can be sent to any audience, or embedded in an iframe for use with a dashboard. These URLs reflect all the options that are selected in settings when the view is published, so date ranges, colour mapping and choices about average or max/min values will carry over into the published view.

To publish a view open the settings dialogue (by clicking on the gear icon in the top right hand corner) and look for the publication link:

Exporting data

If you want to pull out your data and stare at its loveliness in a spreadsheet, then you can export from the basic graph/heatmap view. Simply set up the graph to reflect the time period you are interested in, and hit the download button (highlighted below).

The web service will provide a tool that allows you to select the time period you are interested in plus a choice of time steps to integrate the data. You can then download your data.

Integrating data using an API.

For Pro users, the web service offers a customer API that allows time series data to be accessed as JSON objects. API requests are made using HTTPS POST requests with a message body specifying the parameters of the request.

To get an API key for your Purrmetrix account, please contact info@purrmetrix.com. Once issued they will be found on the ‘Team’ page of your account.

For more details on how to create and use the Purrmetrix API, including limits on its use, please see our developers guide documentation.

Look at how to import data from non-native sources.

Sometimes all this data needs to be put into context. If you have regular reports that you need to share with customers, Purrmetrix supports the creation of word report documents on a regular cycle. To find out how, click here.

Need extra help?

If you have data from other sources you don’t need to confine your analysis to data that is collected by Purrmetrix hardware. Importing data creates a new ‘kitten’ icon (an import kitten) which behaves exactly like any other kitten and can be added to all the analytics views in the same way.

To create an import kitten follow these steps:

1. Go to ‘Actions’ and click ‘create import kitten’
2. You will get a dialogue box (see below) which allows you to label the import kitten and make notes on the data source
3. You will need a pre-prepared CSV file to a specific format (see notes below)
4. Drag and drop the CSV file onto the hotspot. Don’t forget to nominate what sort of data you are importing.
5. There will be a short pause and the server will create a new kitten

Adding more data.

You can always add more data to an existing import kitten – double click on the kitten will reveal a hotspot. You can drag and drop another CSV for a different time period and extend the time period that the import kitten covers.

Now you have all of this data you may want to share it or work with it in another application. Click here for more information on sharing data.

Want to go back and look at ways to manage and move hardware in your account? Click here.

Need extra help?

Many customers need to report results on a regular cycle to third parties. Purrmetrix allows our customers to create word based reports that can be run and downloaded whenever needed, including any views you need.

Reports work by using a Word template, which provides placeholders that mark where each view should be included. Choose the views that you want to include in the report and you can then run all the views for the time period you want to report on.

Want more detail?

To make a new report, go to the reports section on the top menu and click ‘Make new report’

1. You can either use one of our prepared templates, or create your own Word document with the right placeholders in it. For more details see the notes section
2. Upload the template to the report on the hot spot
3. To attach views to the report, search for the titles of the views you are interested in. Once the search results are returned drag the view up to the list above the search box. You can reorder the views into the order you wish them to appear in the template
4. When all the views are selected, you can select a date range for your report.
5. Run the analysis for each view by clicking on the tool box icon. You will get a small preview thumbnail once it is completed
6. Once the analyses are complete, click publish and your report will download automatically.

Notes

Reports need a Word template, saved as a .docx format.