Tipify - Connector - Haystack

Tipify - Connector - Haystack

Tipify Haystack Connector
This document guides you through use of the Haystack extension with Tipify™. It provides client and server capabilities.

Enabling the Haystack Extension
Note: Enabling the Haystack extension is done on a per project basis in Skyspark and can not be done on the Host Level.
1.   Login into the Skyspark environment through a valid Superuser or Admin account.
2.  Navigate to an active project, then the Settings App.

3.  Under the Exts Tab of the Settings App, highlight the "haystack" extension.

4.  If the "haystack" extension status reads "disabled" select and highlight the "haystack" extension and press the Enable button in the upper left-hand corner.

Haystack Server
Once you have enabled the Haystack extension, your device acts as a Haystack Server automatically.  The default behavior is to enable discovery. If you wish to disable discovery on a per project basis, then add the 'disableDiscovery" tag on your projMeta, or you can disable discovery on Tipify™ Server via Settings App, Project Tab.



The default https port of 443 is used, but http is supported on port 50000.

Haystack Client
You set up the Haystack Client by adding a connector for each Haystack Server that you want to access.
You must first declare it as a trusted device.

Set Up Trust Uri
1.  Go to the Host app and select Crypto Tab.
2.  Next press Trust Uri button and enter the URI of the device you want to access as a Haystack Server.


Note: If you forget to enter your Trust Uri before you create your connector, you may need to delete it and recreate it.

Adding a Haystack Connector
You need to set up a connector for each Haystack device that you want to access.
1.  Navigate to an active project, then the Connector App.

2.  Select the New Button in the top left hand of the Connector Tab, you will be prompted with window asking which type of Connector you want to create, highlight and select the Haystack Option.  If the option is greyed out, select the Enable button next to it.
Note: If the Haystack option is not available and needs to be enabled, you will need to create a Trusted Uri prior to setting up a Haystack connector


3.  The Haystack Connector Edit window will pop up, fill in the appropriate information, then press the OK button.

  1. dis: Display Name – This is the name used to reference your device.
  2. URI – This is a reference to the device like https://192.168.1.173/api/edge_245G_M19230027 where the last entry is your project.
  3. username – This is the user name like su.
  4. Password – Enter the Password for the device.
4.  Once the connector has been created it can be checked by selecting the connector in the list, then by selecting Ping button to ensure your device is connected properly.

HTTP Access
If you want to provide unencrypted HTTP access to your device, you will need to add a Firewall Rule like Filter / Input / TCP / WAN (or Modem) / Port=50000 / ACCEPT.

Create Points and Bind a Haystack Connection to it
This will walk you though creating a new point that obtains history data from a Haystack connection that was created in the connection app.
1.  Go to the Builder app to create a Sites and an Equipment.
2. The T-Star Info Connectors will be shown on the far right-hand side of the Site Tab in the Builder app.
3. Create a point under the equipment you created, and find the appropriate connection to bind on the list to the right.
4. Click the "Bind" button above the connectors list on the right hand side of the Site Tab to add the necessary tags to the point.
5. Finish setting the binding by adding the "his" tag, and setting the "hisCollectInterval" tag that will be automatically created with the his tag.

Create History Sync Jobs
Next, you need to set up a job to sync your history regularly. The simplest case is to sync all haystack connector points with something like this:
readAll(haystackConnRef and his).haystackSyncHis(null)
Select the Tools app and select Job. Press New and create a job like this one that syncs all haystack points at 1 AM daily.



Reference
The reference information is on your device or server via the Doc app or searchable online at https://skyfoundry.com/doc/
Scroll down to Extensions and select from these:
  1. conn – Connector Extension Framework
  2. equip – Equipment Extension
  3. haystack - Haystack extension
  4. his – Historian Extension
  5. point – Point Extension

    • Related Articles

    • Tipify - Connector - BACnet

      Tipify BACnet Connector This document guides you through use of the Bacnet extension with Tipify™. It provides client and server capabilities. Tipify BACnet Firewall Settings Tipify will need to have some setting saved under its fire wall to allow ...

    • Tipify - Connector - Modbus Serial Communication

      Tipify Modbus Connector - Serial Communication This document guides you through use of the Modbus serial devices with Tipify ™. Hardware The 245 has 2 communication terminals for Modbus serial communications: RS485 and RS232.  Note: Wires connected ...

    • Tipify Extensions - Pulse - tipPulseExt

      Tipify Pulse Extension This document guides you through use of the Pulse extension in the T-Star 245.  The Pulse extension is used to measure the demand and consumption windows based on other points by reading their raw data.  The Pulse extension ...

    • Tipify Extensions - Adio - tipAdioExt

      Tipify Adio Extension The tipAdioExt provides support for local analog and digital IO.  The Adio Extension provides a connector for interpreting pulse counts as Demand and Usage. Hardware Connectors The 245 provides inputs on the rear of the device ...

    • Tipify Extensions - Device Info - tipDeviceInfoExt

      Tipify Device Info Extension This document guides you through use of the T-Star Info Conn extension with Tipify™. It provides battery and modem information for the T-Star device. Verify installation of the Tipify Device Info Extension Note: The ...