Scigiene Wireless Premier Cloud Based Software Software program User Guide

Scigiene Premiere
User Guide
Table of Contents
1. ABOUT Premiere
3
Scigiene PREMIERE
3
DOWNLOADING THE Scigiene APP
3
Scigiene SECURITY
3
II. REGISTRATION
4
LOGGING INTO THE ONLINE SYSTEM
5
REGISTERING A DEVICE
5
III. THE HOMEPAGE
8
IV. SENSOR OVERVIEW
9
MENU SYSTEM
9
V. GATEWAY OVERVIEW
15
HOW GATEWAYS WORK
15
GATEWAY SETTINGS
16
VI. ACTIONS OVERVIEW
23
CREATING AN ACTION
23
VII. SENSOR MAPS OVERVIEW
26
CREATING A SENSOR MAP
26
VIII. REPORTS OVERVIEW
27
ADDING A REPORT
27
IX. USER OVERVIEW
29
ADDING NEW USERS
29
X. NETWORKS OVERVIEW
30
PAGE 1
ADDING A NEW NETWORK
30
EDITING A NETWORK
30
XI. BUY/RENEW OVERVIEW
31
XII. SETTINGS OVERVIEW
32
GENERATING A TOKEN
32
RENEWING A SUBSCRIPTION
33
XIII. WALLET OVERVIEW
34
ADDING A CARD
34
SUPPORT
35
WARRANTY INFORMATION
35
PAGE 2
I. ABOUT
Scigiene PREMIERE
Scigiene Premiere is included for free with all wireless sensors, providing basic features for you
to configure and monitor your sensors online. These basic features only support one
network and one registered user on an account. More advanced settings, permissions, and
actions are available with an upgrade to Scigiene Premiere.
Scigiene 21 CFR PREMIERE
Scigiene 21 CFR Premiere allows for enhanced functionality of your wireless sensors and includes an
advanced software feature set at a low annual cost. All of Scigiene's advanced features are available for
configuration. You can have more sensors on your account, support multiple users, and view floor plans for all
your sensors.
System Requirements
•
•
Ethernet gateways require existing Internet connection
Wireless Sensor Adapter or USB Pro Gateways require Windows PC or 3rd party IoT gateway
Scigiene APP
The Scigiene app is available after purchase of our system by contacting Scigiene for download links.
Android
Choose the Install button and the app will begin to download to your smartphone or tablet.
Apple (iOS)
The app works with iPhone, iPad, and iPod Touch and free to download.
Premiere SECURITY
Security is paramount for the Premiere when it comes to managing your environment and equipment. Great
care and attention to detail has been taken to keep the exchange of data secure on a gateway and in device
communications.
Premiere is the online software and central hub for configuring your device settings. All data is secured on
dedicated servers operating Microsoft SQL Server. Access is granted through the Scigiene user interface, or
an Application Programming Interface (API) safeguarded by 256-bit Transport Layer Security (TLS 1.2)
encryption. TLS is blanket of protection to encrypt all data exchanged between Premiere and you. The same
encryption is available to you whether you are user of Basic or Premiere. You can rest assured that your data
is safe with Scigiene.
PAGE 3
II. REGISTRATION
If this is your first time using the Scigiene online portal, you will need to create a new account. If you have
already created an account, you can skip to the “Logging into the Online System” section. The following
instructions will guide you through creating the account.
1. Open Scigiene in your mobile app or web browser.
2. Navigate your cursor to the “Create Account” link located off to the right.
3. Next you will be asked to enter your account information in the following fields:
Note: If this is a Free Trial, you may not have received a subscription
code yet. Leave the box blank and proceed.
Figure 7
4. When completed, select the “Next" button.
5. This step will complete the user registration process and lead you onto registering your device. For steps on
how to register your device, see the Registering a Device section below.
PAGE 4
LOGGING INTO THE ONLINE SYSTEM
1. Open Premiere in your mobile app or web browser.
2. Enter your username and password.
Figure 8
3. Select the “Login" button.
REGISTERING A DEVICE
STEP 1: ADD DEVICE
1. Add the sensor on Premiere.
Add the sensor to your account by choosing Sensors in the main menu. Navigate to the Add Sensor button.
Desktop
Mobile
2. Find the device ID. See Figure 9.
The Device ID (ID) and Security Code (SC) are necessary to
add a sensor. These can both be located on the label on the
side of your device.
Figure 9
PAGE 5
3. Adding your device. See Figure 10.
You will need to enter the Device ID and the Security Code from
your Sensor in the corresponding text boxes. Use the camera on
your smartphone to scan the QR code on your device. If you do
not have a camera on your phone, or the system is not accepting
the QR code, you may enter the Device ID and Security Code
manually.
•
•
The Device ID is a unique number located on each device
label.
Next, you'll be asked to enter the Security Code from your
device. A security code consists of letters and must be
entered in upper case (no numbers). It can also be found
on the barcode label of your device.
Figure 10
When completed, select the Add Device button.
STEP 2: SETUP
Select your use case. See Figure 11.
To get you up and running fast, your temperature sensor comes
with preset use cases. Choose from the list or create your own
custom settings. You will see what values your readings are
displayed in (Fahrenheit or Celsius), the heartbeat interval, and
aware state settings.
Select the Skip button when completed.
Figure 11
STEP 3: VALIDATION
Check your signal. See Figure 12.
The validation checklist will help you ensure your sensor is
communicating with the gateway properly and you have a strong
signal.
Checkpoint 4 will only complete when your sensor achieves a solid
connection to the gateway. Once you insert the batteries (or flip the
switch on an industrial sensor) the sensor will communicate with the
gateway every 30 seconds for the first few minutes.
Select the Save button when completed.
Figure 12
PAGE 6
STEP 4: ACTIONS
Choose your actions. See Figure 13.
Actions are the alerts that will be sent to your phone or email in the
event of an emergency. Low battery life and device inactivity are two
of the most common actions to have enabled on your device. See
page 12 for how to set actions for your sensor.
Select the Done button when completed.
Figure 13
PAGE 7
III. THE HOMEPAGE
From the Premiere homepage you can view how
many active and/or alerting sensors and gateways,
along with a complete list of networks on your
account. Check this page regularly to make sure that
your system is functioning properly.
Figure 14
MAIN NAVIGATION MENU
The main navigation menu is the primary resource you will refer to for information
regarding your devices and settings. This is broken down into two sections: Overview and
Account.
OVERVIEW
• Home - This will take you back to the homepage.
• Sensors - View and modify sensors on your account.
• Gateways - Adjust settings for your gateways.
• Actions - Create and edit actions for your sensors.
• Maps - Upload floorplans and position sensors where they are located in your
environment. (Available only for Premiere Members.)
ACCOUNT
• Reports - Assemble detailed summaries for your system.
• Users - Modify all permissions and settings for users on your account. (Unlimited users
only available for Premiere Members)
• Networks - Review and edit all networks on your account. (Multiple networks only
available for Premiere members)
• Buy/Renew - Add notification credits on your account.
• Settings - Subscribe to Scigiene Premiere and adjust account preferences.
Figure 15
Each of these options are covered in their own user guide sections. Read on for more information on these
various pages.
PAGE 8
IV. SENSOR OVERVIEW
Select Sensors from the main navigation menu to access the sensor overview page and begin making
adjustments to your sensors.
MENU SYSTEM
Details - Displays a graph of recent sensor data.
Readings - List of all past heartbeats and readings.
Actions - List of all actions attached to this sensor.
Settings - Editable levels for your sensor.
Calibrate - Reset readings for select sensors (Not available for all sensor types).
Scale - Change the scale of readings for your sensor (Not available for all sensor types).
Directly under the tab bar is an overview of your sensor. This allows you to see the signal strength and the
battery level of the selected sensor.
•
•
•
•
Green indicates the sensor is checking in and within user defined safe parameters.
Red indicates the sensor has met or exceeded a user defined threshold or triggered event.
Gray indicates that no sensor readings are being recorded, rendering the sensor inactive.
Yellow indicates that the sensor reading is out of date, due to perhaps a missed heartbeat check-in.
Details View
The Details View will be the first page you see upon selecting which sensor you would like to modify.
A. The sensor overview section will be above every
page. This will consistently display the present reading,
signal strength, battery level, and status.
B. The Recent Readings section below the chart shows
your most recent data received by the sensor.
C. This graph charts how the sensor fluctuates
throughout a set date range. To change the date range
displayed in the graph, navigate up to the top of the
Readings Chart section on the right-hand corner to
change the from and/or to date.
Figure 16
PAGE 9
Readings View
Selecting the “Readings” tab within the tab bar allows you to view the sensor's data history as time stamped
data.
Figure 17
On the far right of the sensor history data is a cloud icon. Selecting this icon will export an excel file for your
sensor into your download folder.
The data file will have the following fields:
Message ID: Unique identifier of the message in our database.
Sensor ID: If multiple sensors are exported you can distinguish which reading was from which using this
number even if the names for some reason are the same.
Sensor Name: The name you have given the sensor.
Date: The date the message was transmitted from the sensor.
Value: Data presented with transformations applied but without additional labels.
Formatted Value: Data transformed and presented as it is shown in the monitoring portal. Battery: Estimated
life remaining of the battery.
Raw Data: Raw data as it is stored from the sensor.
Sensor State: Binary field represented as an integer containing information about the state or the sensor when
the message was transmitted. (See “Sensor State Explained” below).
Gateway ID: The Identifier of the gateway that relayed the data from the sensor.
Alert Sent: Boolean indicating if this reading triggered a notification to be sent from the system.
Signal Strength: Strength of communication signal between the sensor and the gateway, shown as
percentage value.
PAGE 10
Voltage: Actual voltage measured at the sensor battery used to calculate battery percentage, similar to
Received Signal you can use one or the other or both if they help you.
State
The integer presented here is generated from a single byte of stored data. A byte consists of 8 bits of data that
we read as Boolean (True (1)/False (0)) fields.
Using a temperature sensor as an example.
If the sensor is using factory calibrations the Calibrate Active field is set True (1) so the bit values are
00010000 and it is represented as 16.
If the sensor is outside the Min or Max threshold, the Aware State is set True (1) so the bit values are
00000010 and it is represented as 2.
If the customer has calibrated the sensor this field the Calibrate Active field is set False (0) AND the sensor is
operating inside the Min and Max Thresholds, the bits look like 00000000 this is represented as 0.
If the sensor is using factory calibrations and it is outside the threshold the bit values are 00010010 and it is
represented as 18 (16 + 2 because both the bit in the 16 value is set and the bit in the 2 value is set).
Note: These two are the only bits that typically observed outside of our testing procedures.
PAGE 11
Settings View
To edit the operational settings for a sensor, choose the “Sensor” option in the main navigation menu then
select the “Settings” tab to access the configuration page. The example below is for a Temperature Sensor.
A. Sensor Name is a unique name you give the sensor to
easily identify it in a list and in any notifications.
B. The Heartbeat Interval is how often the sensor
communicates with the gateway if no activity is recorded.
C. Aware State Heartbeat is how often the sensor
communicates with the gateway while in an Aware State.
D. Assessments per Heartbeat is how many times
between heartbeats a sensor will check its measurements
against its thresholds to determine whether it will enter an
Aware State.
E. Below is the minimum reading the sensor should
record before entering an Aware State.
F. Above is the maximum reading the sensor should
record before entering an Aware State.
G. The Aware State Buffer is a buffer to prevent the
sensor from bouncing between Standard Operation and
Aware State when the assessments are very close to a
threshold. For example, if a Maximum Threshold is set to
90° and the buffer is 1°, then once the sensor takes an
assessment of 90.1° it will remain in an Aware State until
dropping to 89.0°.
Figure 18
H. In small sensor networks the sensors can be set to
synchronize their communications. The default setting off
allows the sensors to randomize their communications
therefore maximizing communication robustness. Setting
this will synchronize the communication of the sensors.
I. Failed transmissions before link mode is the number of transmissions the sensor sends without response
from a gateway before it goes to battery saving link mode. In link mode, the sensor will scan for a new gateway
and if not found will enter battery saving sleep mode for up to 60 minutes before trying to scan again. A lower
number will allow sensors to find new gateways with fewer missed readings. Higher numbers will enable the
sensor to remain with its current gateway in a noisy RF environment better. (Zero will cause the sensor to
never join another gateway, to find a new gateway the battery will have to be cycled out of the sensor.)
The default heartbeat interval is 120 minutes or two hours. It is recommended that you do not lower your
heartbeat level too much because it will drain the battery.
PAGE 12
Finish by selecting the Save button.
Calibrate View
If a sensor type has readings that need to be reset, the “Calibrate” tab will be available for selection in the
sensor tab bar.
Figure 19
To calibrate a sensor, you will want to ensure that the environment of the sensor and other calibration device is
stable. Note the “Expected Next Check-in” time for the sensor you are calibrating and take a reading from your
calibration device a few minutes prior to the sensors next check-in.
Enter the actual (accurate) reading from the calibration device into the text field. If you need to change the unit
of measurement you can do that here.
Press Calibrate.
To ensure that the calibration command is received prior to the sensors next check-in, press the control button
on the back of the gateway, once, to force communication (Cellular and Ethernet gateways).
After pressing the Calibrate button and choosing the gateway button, the server will send the command to
calibrate the specified sensor to the gateway. When the sensor checks-in, it will send the pre-calibration
reading to the gateway, then receive the calibration command and update its configuration. When the process
is completed, it will send a “Calibration Successful” message. The server will display the sensor’s last precalibrated reading for this check-in, then all future readings from the sensor will be based on the new
calibration setting.
It is important to note that after calibrating the sensor, the sensor reading returned to the server is based on
pre-calibration settings. The new calibration settings will take effect on the next sensor heartbeat.
Creating a Calibration Certificate
Creating a sensor calibration certificate will mask the calibration tab from those who should not have
permissions to adjust these settings. Permissions for self-certifying a calibration must be enabled in user
permissions.
Directly below the calibrate button is the selection to Create Calibration Certificate.
PAGE 13
A. The Date Created will be filled with the current date by default.
B. The Certificate Valid Until field must be set one day in the future
after the date contained in the "Date Certified" field.
C. Calibration Number is a unique number for your calibration
certificate.
D. Calibration Type is unique to
Choose the Save button before moving on.
Figure 20
When the new certificate is accepted, the Calibration tab will change to a Certificate tab.
Figure 21
You will still be able to edit the certificate by choosing the Certificate Tab and navigating down to Edit
Calibration Certificate.
The tab will revert back to "Calibrate" after the period for the certificate ends.
Scale View
If the sensor settings are influenced by temperature, the scale option will be
available in the tab bar. To change the temperature unit of measurement
from Fahrenheit to Celsius or vice versa, select the Scale tab.
Choose the text box to trigger a pop-up window allowing you to change the
scale. Select the scale you prefer and push "Set."
Press the Save button to complete your adjustment.
Figure 22
PAGE 14
V. GATEWAY OVERVIEW
HOW GATEWAYS WORK
A gateway is the device that manages communication between your sensors and servers. On startup, the
gateway will periodically transmit a heartbeat, checking in with the servers to make sure it is still receiving an
active signal. Sensors also have heartbeats and will relay information to the gateway, which then forwards the
data to the server. There are four different types of gateways:
Cellular, International Cellular, Ethernet, USB, and Serial Modbus Gateway. All gateways require an active
Premiere account in order to be operational. Gateway settings can be accessed on Scigiene or in the offline
local interface.
•
•
•
•
Cellular Gateways: Uses cell towers to facilitate communication between gateways and the monitoring
system.
Ethernet Gateways: Requires an Ethernet cable to establish a connection between your gateway and
Scigiene Servers using an IEEE 802.3 network.
USB Gateways: Uses an existing internet connection on a PC to facilitate communication with the
Scigiene servers.
Serial Modbus Gateway: Acts as a data concentric for Scigiene wireless sensor networks.
Cellular, International Cellular, Ethernet, USB, and Serial Modbus Gateway. All gateways require an active
Premiere account in order to be operational. Gateway settings can be accessed on Scigiene or in the
offline local interface.
In order for your wireless sensors to work optimally, you should orient all antennas for your sensor(s) and
gateway(s) the same direction (typically vertical).
More Signal
Less Signal
Figure 23
PAGE 15
GATEWAY SETTINGS
On Premiere, find Gateways in the main navigation menu to start modifying your
gateway settings.
A list of all the gateways registered to your account will display. There should be at
least one gateway registered to your account in order for your sensors to be active.
Select one of your gateways from the list. There will be a series of tabs allowing you to
view the status of your gateway and make changes.
Figure 24
Figure 25
A. History —This will be the first page to display. With a list of data received from previous heartbeats. If there
have been any alert states in the past, they will show up here.
B. Actions — This will display a list of all the actions you have under this gateway. If you have not assigned
any events to this gateway, the page will be blank. For tips on how to set an action, see Getting Started —
Actions for more information.
C. Settings — If you would like to make changes to your gateway network connection, you can do so here
under the Settings section.
D. Sensor List — Here you will see a list of sensors registered to the gateway. If there aren’t sensors
registered to the gateway, the list will be blank.
Gateway History View
The first tab to display when entering your gateway will be the History tab, allowing you to view gateway
messages as time stamped data.
Figure 26
•
On the far right of the gateway history data is a cloud icon. Selecting this icon will export an excel file
for your sensor into your download folder.
PAGE 16
Gateway Action View
All actions assigned to the gateway can be found by selecting the Actions tab. If there are no active actions,
none will be listed for the gateway. From here you have the option of selecting an action to edit, pausing
notifications, or delaying alerts for one hour. For more on creating and editing action notifications, see the
Action section of this guide.
Figure 27
Gateway Settings View
Select the Settings tab to enter gateway settings. Depending
on the gateway model, there may be a different collection of
general settings available for modification.
Ethernet Gateway General Settings
A. The Gateway Name field is where you assign your gateway
a unique title. By default, the gateway name will be the type
followed by the Device ID.
B. The Heartbeat Minutes configures the interval that the
gateway checks in with the server. The default is five minutes.
So, every five minutes your gateway will report to the server.
C. The Poll Rate Minute setting only applies if you are using
Scigiene Control or Scigiene Local Alert. Here’s how it works: to
conserve cellular data, your gateway has a set heartbeat
(meaning it only exchanges data with the Scigiene server once
every five minutes by default). If you are using Scigiene Control
or Scigiene Local Alert, you may want to control equipment or
receive local alerts more frequently. If you were to increase
your gateway heartbeat, you would increase your data usage
substantially.
Figure 28
Setting a poll rate allows your gateway to check for priority
incoming messages more frequently — while using a fraction of
the data of a regular message exchange. Your gateway asks
the Scigiene server if there are any priority incoming messages,
and if there are, they are exchanged immediately. If not, no messages are exchanged until your
gateway has its next regular heartbeat.
PAGE 17
G. Force Transmit on Aware means that if the sensors reach an aware state outside of the five-minute
heartbeat interval, the gateway will immediately relay that data to the server instead of waiting the extra time it
would take to reach the next heartbeat minute.
Setting a poll rate allows your gateway to check for priority incoming messages more frequently — while using
a fraction of the data of a regular message exchange. Your gateway asks the Scigiene server if there are any
priority incoming messages, and if there are, they are exchanged immediately. If not, no messages are
exchanged until your gateway has its next regular heartbeat.
D. Force Transmit on Aware means that if the sensors reach an aware state outside of the five-minute
heartbeat interval, the gateway will immediately relay that data to the server instead of waiting the extra time it
would take to reach the next heartbeat minute.
E. The Primary Server is the main server your gateway is programmed to communicate with. The Secondary
Server is the next server the gateway will issue communication through if it cannot contact the Primary Server.
Cellular Gateway General Settings
A. The Gateway Name field is where you assign your gateway
a unique title. By default, the gateway name will be the type
followed by the Device ID.
B. The Heartbeat Minutes configures the interval that the
gateway checks in with the server. The default is fifteen
minutes. So, every fifteen minutes your gateway will report to
the server.
C. The IMSI (International Mobile Subscriber Identity) number
as the mode to identify the country, mobile network, and
subscriber. It is formatted as MCC-MNC-MSIN. MCC is the
Mobile country Code. MNC is the Mobile Network Code
attached to the cellular network. MSIN is a sequential serial
number making the IMSI unique to a subscriber.
D. The ICCID is the nineteen-digit unique identification number
corresponding to the cellular SIM card. It is possible to change
the information contained on a SIM (including the IMSI), but the
identity of the SIM itself remains the same.
E. IMEI (International Mobile Equipment Identity) is a number
exclusive to a Cellular Gateway to identify the gateway to the
cell tower.
Figure 29
F. Force Transmit on Aware means that if the sensors reach an aware state outside of the
five-minute heartbeat interval, the gateway will immediately relay that data to the server instead
of waiting the extra time it would take to reach the next heartbeat minute.
G. Gateway Power Mode is a dropdown menu to select how much power your gateway uses. Choose
between Standard, Force High Power, or Force Low Power.
PAGE 18
Network
Choose the Network bullet under the Settings title for an Ethernet Gateway to open up the local area network
configuration page. The Local Area Network includes the ability to switch your network IP address from DHCP
to Static. DHCP will be the default network IP address.
Multiple interfaces can be active, but they each need a static IP address on the Gateway. Internet Service
Providers (ISPs) assign IP (Internet Protocol) addresses to a computer so users can access the Internet. An IP
address is a unique number typically formatted as 000.000.000.0.
To change your IP address to a Static IP, navigate to the network IP option and switch it from DHCP to Static.
Then input your data for the Static IP, Network Mask, Default Gateway, and Default DNS Server.
Figure 30
Static IP - A static Internet Protocol (IP) address is a numerical sequence assigned to a computer by an
Internet Service Provider (ISP). This is different from a Dynamic IP Address in that a Static IP doesn’t
periodically change and remains constant.
Network Mask - More commonly known as a “subnet mask” this number hides the network half of an IP
address. The most common Network Mask number is 255.255.255.0.
Default Gateway - This is the forwarding host a computer utilizes to relay data to the Internet.
Default DNS Server - DNS Servers take alphanumerical data (like a URL address) and dial the number for the
server containing the information you’re looking for.
PAGE 19
Commands
Choose the bullet for Commands located just under the Settings title to access the commands page.
Figure 31
Selecting the Reform Network command will trigger the gateway to remove all sensors from its internal whitelist, and then request a new sensor list from the server. This command will force all sensors to reinitialize their
connection with the gateway.
Reforming the network cleans up communication when multiple networks are in range of each other so they
are all in sync. This is especially useful if you have move sensors to a new network, and would like to clear
these sensors from the gateways internal list.
Reforming the network will place a new list of sensors that will continue to exchange data.
If there are updates available for your gateway firmware, the Update Gateway Firmware button will appear,
giving you the option to select it and install the latest firmware.
Choosing the Reset Gateway to Factory Defaults button will erase all your unique settings and return the
gateway to factory default settings.
Interface
There are three additional interfaces available for activation on
your Gateway Settings page. To activate them, choose the
Interface button. Toggle on each of the interfaces to access their
individual settings.
Figure 32
PAGE 20
SNMP Interface — SNMP (Simple Network Management Protocol)
compiles information from a variety of clients. This is especially helpful
if you have multiple gateways for devices that need to communicate
with the gateway. Scigiene gateways can manage up to four clients.
For more on the SNMP Interface visit the article SNMP Interface
Configuration. Scigiene gateways can manage up to four clients. The
SNMP settings for a gateway can be adjusted on Scigiene and the
offline local interface. You can continue to use SNMP without the
server interface active. The data will not be sent to a server, but you
can continue to poll for the data as it is received by the gateway.
• SNMP Address — This is the IP address for the SNMP Client you
wish to communicate with the device. The Enterprise Gateway has
sensor information @ 40101 - 40116 (100 — 115 raw address), and
every 16 after in the same pattern; 40117 — 40132.
(116-131 raw) is the next set of 16. Addresses of 0-15, 16-31, 32-47
refer to sensor slots 1, 2 and 3. This is the same as the Register
Address of 40001-40016, 40017-40032, and 40033-40048.
• Port - The number for where the server data from the gateway is
received. Ports 80 and 443 are reserved for https traffic. Web browsers
use these ports to send requests to web servers.
• Trap Active — A “Trap” for an SNMP is an alert state sent from your
connected device to the gateway which is then relayed to the server. By
default, this option is off, but you can turn it on by toggling the switch
over into the on position.
• Trap Port — The server port where the trap alert state is sent when
active.
Figure 33
Modbus Interface — Modbus TCP (Transmission Control
Protocol) is the Modbus RTU protocol with a TCP interface
that runs on Ethernet. This allows blocks of binary data to be
exchanged between computers. TCP is responsible for
making sure all data is correctly received. IP (Internet
Protocol) is responsible for making sure data is correctly
addressed and routed. Scigiene provides the Modbus TCP
interface for you to pull gateway and sensor data. You can
continue to use Modbus without the server interface active.
The data will not be sent to a server, but you can continue to
poll for the data as it is received by the gateway
Figure 34
PAGE 21
Real-time TCP - Real Time TCP (Transmission Control Protocol)
guarantees response within a specific deadline. TCP is responsible for
making sure all data is correctly received by the IP address. A static IP
must be set on the gateway.
• TCP Timeout Seconds — The amount of time the gateway waits for
a request to be received by the server before the session times out
and the connection is refused.
• Port — The number for where the server data from the gateway is
received. Ports 80 and 443 are reserved for https traffic. Web
browsers use these ports to send requests to web servers.
Figure 35
Sensor List View
Choose the Sensor List tab to view a complete count of all sensors reporting to the selected gateway. This is
only a list of the sensors. They cannot be edited from this page.
Figure 36
PAGE 22
VI. ACTIONS OVERVIEW
Notifications for a single sensor or gateway can be created, deleted, and edited by selecting the “Actions” tab
in the sensor tab bar.
Figure 37
You can toggle the Action Trigger on or off by selecting the switch under Current Action Triggers.
CREATING AN ACTION
Actions are triggers or alarms set to let you know when a sensor reading identifies that immediate attention is
needed. Types of actions include sensor readings, battery level, device inactivity, and scheduled data. Any one
of these can be set to send a notification or trigger an action in the system.
Select “Actions” in the main navigation menu.
Figure 38
A list of previously created actions will display on the screen. From here, you have the ability to filter, refresh,
and add new actions to the list.
PAGE 23
•
From the Actions page, tap “Add Action” in the left-hand corner.
Figure 39
Step 1: What triggers your action?
•
The dropdown menu will have the following options for
Action Types:
Sensor Reading: Set actions based on sensor activity or reading.
Battery Level: This is where you can set to be notified when the
battery level drops below a percentage. 15% is the default setting.
Device Inactivity: Actions when the device doesn't communicate
for an extended period of time.
Advanced: Actions based on advanced rules, such as comparing
past data points with current ones.
Scheduled: These are actions that fire at a time set basis.
•
•
•
•
Select Sensor Reading from the dropdown menu.
A second dropdown menu will appear. From here, you will
be able to see a list of the different type of sensors
registered to your account. Choose Temperature in the
dropdown menu.
Next, you will be asked to input the trigger settings. You have the option of setting this
trigger for greater than or less than a temperature reading.
Press the “Save” button
Figure 40
If you don't have a temperature sensor, the option in this
example won't be available, select any variable output
sensor and follow along.
Variable output sensors can have multiple event triggers
created.
Example: A temperature sensor used in a freezer. You
may want to be notified if the temperature goes below 0°
or above 30° Fahrenheit. You would create two events.
• Action 1- Trigger Set for temperatures LESS THAN 0°F.
• Action 2 - Trigger set for temperatures GREATER THAN
30° F.
Figure 41
Step 2: Actions
Press the Add Action button under the Event Information header and available action types are presented in a
select list.
• Notification Action: Specify account users to receive notifications when this event triggers.
• System Action: Assign actions for the system to process when this event triggers.
PAGE 24
• Choose Notification Action from the notification list.
Figure 42
A. Configure the subject for the notification.
B. Customize the message body for the notification
C. Save button commits any changes to message content fields.
D. Recipient list identifies who will receive the notification.
• Select the icon next to a user to configure how they will be notified
• Choose if you want notifications sent immediately when triggered or if
you want a delay before it is sent and press Set.
• A green icon indicates the users that will receive the notifications.
• If a delay has been selected, the delay time will display beside the
icon.
Figure 43
• Select System Action from the Add Action list.
• Scroll down to the System Action section.
• The Action to be Done select list has the following options.
° Acknowledge: Automatically signal that you have been notified of an
action. When an action has been triggered, alerts will continue
processing until the action returns to a value that no longer triggers an
action.
° Full Reset: Reset your trigger so it is armed for the next reading.
° Activate: Enable an action trigger.
° Deactivate: Disable an action trigger.
Step 3: Action Name and Devices
By default, the sensor(s) will not be assigned to the action conditions
you’ve just set. To assign a sensor, find the device(s) you want to
designate for this action and select. Selected sensor boxes will turn
green when activated. Choose the sensor box again to unassign the
sensor from the action.
Continue toggling the sensor(s) corresponding to this new action until
you are satisfied with your selection. These can be adjusted later by
returning to this page.
Press the “Checkmark button” to complete the process.
Figure 44
Figure 45
PAGE 25
VII. SENSOR MAPS OVERVIEW
The Maps feature gives you the option of uploading your floorplan or other image to Scigiene and allows you to
virtually position sensors where you have physically placed sensors in the location. This is useful if you have
multiple sensors and want to know see them in context of where they are placed. This guide will walk you
through uploading a floorplan and positioning sensors.
CREATING A SENSOR MAP
1. Find the main navigation menu. and select “Maps.”
2. All previously created sensor maps will display.
3. To create a new sensor map, locate Create Sensor Map button.
Figure 46
Figure 47
•
•
•
•
•
The following page will ask you to enter a title for your new sensor map.
Next you will upload a picture of your floorplan. Acceptable image formats are: bmp, gif, jpg, png, tiff.
The following screen will be the Edit Map page. Choose the sensor you want to add to the map. The
checkmark will turn green and the sensor icon will appear on the map.
You can then drag it to the designated location on the map. Once your sensors are in you the desired
locations, proceed to view the map.
Select the Save button.
PAGE 26
VIII. REPORTS OVERVIEW
Reports are delivered regularly via email, updating you on sensor activity. The
interval of these reports is easy to set and can even be submitted as one-time
non-recurring updates. Regular reports help you stay up to date on your sensor
activity. This guide will walk you through setting up a battery health report. You
can use the same steps to set up other reports as needed. Some parameters
will differ slightly depending on the type of report you select.
Figure 48
ADDING A REPORT
To create a new report, select Create Report button.
Figure 49
• Choose a Report Template.
Figure 50
The following will use a “NeMork Data Export” option as an example:
Edit Report Section
A. The Report Name is the primary identifier for the report.
B. Schedule your report for daily or once a week.
C. Set the time-of-day delivery for morning, mid-day, evening, or night.
Figure 51
PAGE 27
Report Specific Parameters Section
A. The Network ID assigns the network to the report.
B. Data start hour sets the time that the data will begin collecting.
C. Sensor Name adds the name of sensors to the report.
D. Date adds the calendar date to the report.
E. Include Value adds a value to the report.
F. Include Formatted Value adds a formatted value to the report.
G. Include Battery adds the battery percentage to the report.
Figure 52
H. Include Data adds data entries to the report.
I. Include Sensor State adds the sensor state to the report.
J. Include GatewaylD adds the gateway ID to the report.
K. Include Alert Sent adds the type of alert to the report.
L. Include Signal Strength adds the value for signal strength to
the report.
M. Include Voltage adds the voltage data to the report.
N. Include Special adds additional data into extra columns.
Select the Save button.
Figure 53
PAGE 28
IX. USERS OVERVIEW
The user list page can be accessed through the main menu. The user list will
display all users who have access to your account. Basic Scigiene subscriptions
may only have one primary user for the account.
The ability to add users to an account is an exclusive feature of Scigiene
Premiere. Having additional users on an account gives you the chance to act as
an administrator and control what each person is allowed to see and do on the
account. This can be extremely helpful for a large company and several people
need access to Scigiene sensors in the event of an emergency.
Figure 54
ADDING NEW USERS
1. Select the Add User button
Figure 55
2. The Add User page will appear. Fill out all the text fields. The username will auto
populate with the email address. The password must be at least eight characters.
Checking the box for "Is Administrator" gives the new user the ability to add new
users to the account. By default, the box is not checked. Leave this box unchecked
if you do not want them to have this ability.
After you have entered all the account information, select the Submit button.
Figure 56
After submitting the new user information, the following tabs will guide you through
editing their settings.
A. User Details lists new user's account information. This is where the password can
be changed and reset. This information can be downloaded to your computer by
clicking the cloud icon in the upper right corner.
B. User Permissions gives the administrator(s) the option of blocking users from
having full access to the site.
Options include: Acknowledge Notifications, Edit Gateway Configuration, Password
Unlock, and more.
Figure 57
C. User Preferences has a small list of custom settings for Scigiene.
D. Edit Notification Details is where you can adjust settings for how you want to be alerted about
errors in sensors and gateways. You can receive these alerts over email, text (SMS) messaging, or voicemail.
By default, notifications will be off, if not adjusted. Activation can be accomplished by triggering the "Turn On
Notifications" switch.
PAGE 29
X. NETWORKS OVERVIEW
The following network list page allows you to edit details, create new sensor
networks, and manage wireless gateways and sensors.
To have multiple, unlimited, networks is a feature available only for Scigiene
Premiere members. Basic members will only be able to have one network and
one account.
Figure 58
ADD A NEW NETWORK
1. Select the New Network button.
Figure 59
2. Enter the network name on the next screen. Select the Save button.
3. The next screen will have fields to customize the network:
A. Name: This is the identifier the new network will be known by.
B. Notifications Enabled: Checking this box sets notifications to
be sent from the network.
C. Holding Enabled: Checking this box sets this as a holding
network. Sensor limits are not enforced and a gateway will not
download the sensor to the network sensor list.
D. Install Tech Access Cutoff Date: Presents the option to
make changes to a device on the network during an install period.
The date is set one day in the past by default.
E. Device Xml Download: Download an Xml file to a computer or
mobile device.
F. Add Device to Network: Add devices to this new network.
See page 6 of this guide for instructions. Remember that
gateways must be added to the network before sensors.
Figure 60
EDITING A NETWORK
Choose any network from the list to edit the network. The network settings screen will be the same as above.
Below that is a list of sensors and gateways that can be added or deleted.
The network edit page will display the option of changing the name of your network, enable notifications,
enable holding, and review the Install Tech Access Cut-off Date.
Remember to press the Save button after making any changes in this section.
PAGE 30
XI. BUY/RENEW OVERVIEW
Selecting “Buy/Renew” from the main menu opens a page to record notification credits for an account.
There are no credits required for e-mail notifications. There are also no credits required for External Provider
SMS text (Short Message Service), which is not available in all areas.
Credits are required for Direct SMS and Voice Messaging based on the recipient’s country.
A. This is a running count of how many notification credits are on the
account.
B. To redeem new notification credits, enter the code in this box and
select the button for Redeem Code.
C. This box displays the number of credits available to be used.
D. This box displays the threshold for credit or limit they are allowed
to reach.
E. Select the dropdown menu to choose a user to be notified.
F. This box enables the ability to assign Administrative Credits.
G. This box sets an expiration date for the Administrative Credits.
Figure 61
PAGE 31
XII. SETTINGS OVERVIEW
Select the Settings tab to modify incorrect personal account information.
Account Number: This is a unique number for your account. If there is no
account number, this entry will be the same as your name.
Figure 62
Company Name: This is an optional field for the Company Name. If there is no Company Name present this
field will be the same as your name.
Primary Contact: This field displays your name along with your email. This a mandatory field as there must be
a primary contact for the account to remain active so notifications can be sent.
Time Zone: There are a number of settings in Scigiene that are dependent on time. Set the time zone for your
account here by first selecting a region and then a zone from the drop-down list.
Address, City, State, Postal Code, Country: These next few fields apply to your physical street address.
Recovery Email: An optional field for a secondary email address if your primary email cannot be reached.
Reseller: Check this box if you are a verified reseller.
Max Failed Logins: The maximum number of failed login attempts you wish to allow in order to protect your
account from being hacked.
Remember to press the Save button after making any changes.
GENERATING A TOKEN
If you ever have to call into Scigiene technical Support, you may be asked to
provide an Account Access Token. An Access Token is an alphanumerical
code valid for 24 hours so Scigiene support can assist with issues on the
account. It can be extended or revoked if the problem is solved no longer wish
to grant access.
Figure 63
Scroll down to the Subscription section and select the Generate Token button Choose the button to receive
the unique access code.
Figure 64
The code will automatically expire in 24 hours. Selecting the Extend button will grant a onetime week-long
extension period before mandatory expiration. Choose the Revoke Token button to end access prior to the
expiration date.
PAGE 32
RENEWING A SUBSCRIPTION
Premiere Subscriptions are given out on a yearly basis. When it is time to renew, an email notification will be
sent to let you know the subscription is about to expire.
A. The new store name will be a combination between your
Scigiene user name and the twelve-digit time stamp for when you
created the account.
B. Unlinking your account will take you back to the login page.
C. Select this link to visit the online store and see what sort of
options are out there to buy.
D. After you enter your card holder information, you can now
move on to purchase a subscription to your account.
In the products section, you will see a list of Scigiene Premiere
software. You must purchase a premiere account greater than the
number of sensors registered to your account. If you have seven
sensors, you cannot purchase “Scigiene Premiere for Up to 6
Sensors.” You need to select “Scigiene Premiere for Up to 12
Sensors” to support all your devices.
• Choose a radio button for the subscription you wish to purchase.
• Select the “Checkout” button.
You’ll be brought to the purchase screen.
The purchase screen will give you one last chance to review your shopping cart. Sales tax is automatically
placed into the calculation of the price. This is software, so there is no added shipping cost. If everything meets
your expectations, select the “Purchase” button.
The new subscription will be added to the list of Active Subscriptions on the Account Details tab.
PAGE 33
XIII. WALLET OVERVIEW ADDING A CARD
ADDING A CARD
New cards can always be added in the “Add Card to Wallet” section. Fill out the typical credit card information
including the Card Holder name, card number, expiration date and address. Then select the Save button.
PAGE 34
SUPPORT
For technical support and troubleshooting contact Scigiene at [email protected] or at 416-261-4865
WARRANTY INFORMATION
(a) Scigiene warrants that Scigiene-branded products (Products) will be free from defects in materials and
workmanship for a period of one (1) year from the date of delivery with respect to hardware and will materially
conform to their published specifications for a period of one (1) year with respect to software. Scigiene may
resell sensors manufactured by other entities and are subject to their individual warranties; Scigiene will not
enhance or extend those warranties. Scigiene does not warrant that the software or any portion thereof is error
free. Scigiene will have no warranty obligation with respect to Products subjected to abuse, misuse, negligence
or accident. If any software or firmware incorporated in any Product fails to conform to the warranty set forth in
this Section, Scigiene shall provide a bug fix or software patch correcting such non-conformance within a
reasonable period after Scigiene receives from Customer (i) notice of such non-conformance, and (ii) sufficient
information regarding such non-conformance so as to permit Scigiene to create such bug fix or software patch.
If any hardware component of any Product fails to conform to the warranty in this Section, Scigiene shall, at its
option, refund the purchase price less any discounts, or repair or replace nonconforming Products with
conforming Products or Products having substantially identical form, fit, and function and deliver the repaired or
replacement
Product to a carrier for land shipment to customer within a reasonable period after Scigiene receives from
Customer (i) notice of such non-conformance, and (ii) the non-conforming Product provided; however, if, in its
opinion, Scigiene cannot repair or replace on commercially reasonable terms it may choose to refund the
purchase price. Repair parts and replacement Products may be reconditioned or new. All replacement
Products and parts become the property of Scigiene. Repaired or replacement Products shall be subject to the
warranty, if any remains, originally applicable to the product repaired or replaced.
Customer must obtain from Scigiene a Return Material Authorization Number (RMA) prior to returning any
Products to Scigiene. Products returned under this Warranty must be unmodified.
Customer may return all Products for repair or replacement due to defects in original materials and
workmanship if Scigiene is notified within one year of customer’s receipt of the product. Scigiene reserves the
right to repair or replace Products at its own and complete discretion. Customer must obtain from Scigiene a
Return Material Authorization Number (RMA) prior to returning any Products to Scigiene.
Products returned under this Warranty must be unmodified and in original packaging. Scigiene reserves the
right to refuse warranty repairs or replacements for any Products that are damaged or not in original form. For
Products outside the one-year warranty period repair services are available at Scigiene at standard labor rates
for a period of one year from the Customer’s original date of receipt.
(b) As a condition to Scigiene’s obligations under the immediately preceding paragraphs, Customer shall return
Products to be examined and replaced to Scigiene’s facilities, in shipping cartons which clearly display a valid
RMA number provided by Scigiene. Customer acknowledges that replacement Products may be repaired,
refurbished or tested and found to be complying. Customer shall bear the risk of loss for such return shipment
and shall bear all shipping costs. Scigiene shall deliver replacements for Products determined by Scigiene to
be properly returned, shall bear the risk of loss and such costs of shipment of repaired Products or
replacements, and shall credit Customer’s reasonable costs of shipping such returned Products against future
purchases.
(c) Scigiene’s sole obligation under the warranty described or set forth here shall be to repair or replace nonconforming products as set forth in the immediately preceding paragraph, or to refund the documented
purchase price for non-conforming Products to Customer. Scigiene’s warranty obligations shall run solely to
Customer, and Scigiene shall have no obligation to customers of Customer or other users of the Products.
PAGE 35
Limitation of Warranty and Remedies
THE WARRANTY SET FORTH HEREIN IS THE ONLY WARRANTY APPLICABLE TO
PRODUCTS PURCHASED BY CUSTOMER. ALL OTHER WARRANTIES, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY
DISCLAIMED. SCIGIENE'S LIABILITY WHETHER IN CONTRACT, IN TORT, UNDER ANY
WARRANTY, IN NEGLIGENCE OR OTHERWISE SHALL NOT EXCEED THE PURCHASE
PRICE PAID BY CUSTOMER FOR THE PRODUCT. UNDER NO CIRCUMSTANCES SHALL
SCIGIENE BE LIABLE FOR SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES. THE
PRICE STATED FOR THE PRODUCTS IS A CONSIDERATION IN LIMITING SCIGIENE’S
LIABILITY. NO ACTION, REGARDLESS OF FORM, ARISING OUT OF THIS AGREEMENT
MAY BE BROUGHT BY CUSTOMER MORE THAN ONE YEAR AFTER THE CAUSE OF
ACTION HAS ACCRUED.
IN ADDITION TO THE WARRANTIES DISCLAIMED ABOVE, SCIGIENE SPECIFICALLY
DISCLAIMS ANY AND ALL LIABILITY AND WARRANTIES, IMPLIED OR EXPRESSED, FOR
USES REQUIRING FAIL-SAFE PERFORMANCE IN WHICH FAILURE OF A PRODUCT
COULD LEAD TO DEATH, SERIOUS PERSONAL INJURY, OR SEVERE PHYSICAL OR
ENVIRONMENTAL DAMAGE SUCH AS, BUT NOT LIMITED TO, LIFE SUPPORT OR
MEDICAL DEVICES OR NUCLEAR APPLICATIONS. PRODUCTS ARE NOT DESIGNED
FOR AND SHOULD NOT BE USED IN ANY OF THESE APPLICATIONS.
Scigiene Corporation
www.Scigiene.com
Scigiene, Scigiene and all other trademarks are property of Scigiene, Corp.0 2020 Scigiene Corp. All Rights
Reserved.
PAGE 36
">