{ "version": "https://jsonfeed.org/version/1", "title": "SlitherSense Docs", "home_page_url": "https://docs.slithersense.com", "feed_url": "https://docs.slithersense.com/json", "description": "SlitherSense Documentation", "items": [ { "id": "https://docs.slithersense.com/quick-start/", "content_html": "\"SlitherSense\n

What is SlitherSense?

\n

SlitherSense is an easy-to-use platform for monitoring the environment in your pet's vivarium/terrarium (or for any 'container' for that matter).

\n

Document Purpose

\n

The purpose of this document is to get you up and running as fast as possible. The absolute minimum steps to get everything running and configured. If you hate to RTFM, this document is for you.

\n

For a more in-depth review of the system, head over to SlitherSense Overview.

\n

Quickstart Video

\n

For the folks who take it a step further and don't want to read the quick start (RTFQS), we have a video of the process as well:

\n\n

Step-by-step

\n

These are the high-level steps to get online.

\n
    \n
  1. Create SlitherSense Account
    2. \n
  2. Install the App
    \na. Android
    \nb. iOS
    3. \n
  3. Physical Setup
    4. \n
  4. Connect gateway to your Wi-Fi
    5. \n
  5. Claim your Sensors
    6. \n
  6. Create Pet
    7. \n
  7. Assign Pet and Sensors to Vivarium
    8. \n
  8. Set Temp/Humidity Recommendations
    9. \n
  9. Explore
    10. \n
  10. Summary
    11. \n
\n

\n

1. Create SS Account

\n

Head over to https://slithersense.io/signup. Enter email, password, review T&C, click Get Started.

\n

\n\n\n

\n

\n

2. Install the App

\n

Install the app of your choice below. You do not need an account on SlitherSense.io to use the app. It will show real-time data from the sensors as long as you are nearby.
\n
\nAndroid
\nhttps://play.google.com/store/apps/details?id=com.slithersense.app
\n
\niOS
\nhttps://apps.apple.com/app/slithersense/id1670538378

\n

\n

3. Physical Setup

\n
    \n
  1. Plug the gateway into a standards-compliant USB charger using a USB-C cable.
    \n\n
    2. \n
  2. Turn on the sensors by holding down the power button for 3 seconds. A red blinking light will be visible on the front of the sensor once power is on. The blinking light will turn off after 30 seconds.
    \n
    3. \n
  3. Install sensors in vivarium using provided double-sided tape.
    \nDivide the vivarium into two or three zones.
    \nNOTE: You might wish to wait until everything is tested before installing the sensors.
    \nNOTE: BASK on the right and cool on the left is fine too, it's configurable in the user interface.
    \n
    4. \n
\n

\n

4. Connect gateway to your Wi-Fi

\n
    \n
  1. Plug your gateway into power using a standard USB-C cable.
    2. \n
  2. Open the SlitherSense app on your mobile device.
    \nNote: your mobile device must be already joined to the same Wi-Fi network you want to connect the gateway too.
    3. \n
  3. Click "Setup Gateway"
    4. \n
  4. Type in the password (PSK) for your Wi-Fi network.
    5. \n
  5. Click Connect.
    6. \n
  6. Wait a few seconds and you should see a successful connect message.\nIf you do not see a successful connect. Please ensure you have typed in the password correctly. If you send the wrong credentials to the gateway, you will need to reset it to try again.
    7. \n
\n

\n

5. Claim your Sensors

\n
    \n
  1. Open the SS app again on your mobile device.
    2. \n
  2. Click on a sensor in the list.
    \n
    3. \n
  3. The browser will open and prepopulate the form field in Add Device.
    \nThe six-digit number is on the front of the device, after the SS#- model number, e.g. SS1-112233, the unique ID would be 112233.
    4. \n
\n

NOTE: If you open slithersense.io on your computer and don't have any sensors claimed, it will prompt you to add one.
\n

\n

\n

6. Create Pet

\n
    \n
  1. Over at slithersense.io click on Pets->Add a Pet.
    2. \n
  2. Enter your pet's name and click Submit.
    3. \n
  3. On the pet details page select the pet type from the drop-down menu.
    \n\n
    4. \n
  4. Click Save
    5. \n
\n

\n

7. Assign Pet and Sensors to Vivarium

\n

When you create your slithersense.io account a default location and default vivarium are created for you. This is done to speed up this process. You are welcome to rename and edit Default Location and Default Vivarium as you see fit.

\n
    \n
  1. Click the drop down to select the pet you just created to assign it to this vivarium.
    2. \n
  2. In the BASK zone, select the sensor assigned to the bask area in the vivarium.
    3. \n
  3. In the WARM zone, select the sensor assigned to the warm area in the vivarium.
    4. \n
  4. In the COOL zone, select the sensor assigned to the cool area in the vivarium.
    5. \n
  5. Click Save
    6. \n
\n

\n

8. Set Temp/Humidity Recommendations

\n

In the configuration for Default Vivarium, at the bottom, you will be high and low threshold for the three temperature zones of the vivarium, BASK, WARM, COOL. When you assign a pet to the vivarium, if you press the Set Pet Type Recs, it will pull down the recommendations for the type of pet. For example, if you create a pet named Ralph that is a bearded dragon, when you assign Ralph to the vivarium and click the Set Pet Type Recs button, it will apply the recommended temperature and humidity for a bearded dragon to all three zones of the vivarium.

\n
    \n
  1. Press the Set Pet Type Recs button under the pet you have assigned.
    2. \n
  2. Click Save
    3. \n
\n

\n

9. Explore

\n

Head to the dashboard at slithersense.io and click around. The sensors data will be sent to the cloud every 5 minutes by the gateway or mobile app.

\n

\n

10. Summary

\n
    \n
  1. Create SlitherSense Account
    2. \n
  2. Install the App
    \na. Android
    \nb. iOS
    3. \n
  3. Physical Setup
    4. \n
  4. Connect gateway to your Wi-Fi
    5. \n
  5. Claim your Sensors
    6. \n
  6. Create Pet
    7. \n
  7. Assign Pet and Sensors to Vivarium
    8. \n
  8. Set Temp/Humidity Recommendations
    9. \n
  9. Explore
    10. \n
\n", "url": "https://docs.slithersense.com/quick-start/", "title": "Quick Start", "summary": "Getting up and running fast", "date_modified": "2023-02-02T07:50:50.000Z" }, { "id": "https://docs.slithersense.com/overview/", "content_html": "\"SlitherSense\n

What is SlitherSense?

\n

SlitherSense is an ecosystem of products to simplify the monitoring of a reptile or amphibian's environment, particuarly temperature and humidity. For optimal health and a long life, reptiles and amphibians should be be contianed in an environment that mimics what they would experience in nature.

\n

System Overview

\n

The primary components of the SlitherSense system are:

\n\n

Within the hardware category we have sensors and gateways. The gateway's job is to listen for readings from the sensors and send the data to the SlitherSense platform in the cloud.

\n

The User Interface is what you interact with at slithersense.io. This is where you configure your SlitherSense deployment, claim device, set alert thresholds, create users for your account, etc.

\n

The SlitherSense app for both iOS and Android serves three purposes:

\n
    \n
  1. Listen for data from sensors and display readings in real-time.
    2. \n
  2. Send that data over to the SlitherSense platform on the Internet.
    3. \n
  3. Provide a means to transmit the Wi-Fi configuration information to your gateway.
    4. \n
\n

\n

\n

This documentation website breaks down each item with its own page detailing the explanation of the item. Please head to the individual pages for further details about the various components.

\n\"Overview\n

The SlitherSense sensors are Bluetooth Low Energy (BLE) devices with integrated sensors. The first product released by SlitherSense, the SS1, is a water-resistant temperature and humidity sensor. The device gathers telemetry at a set frequency and broadcasts it to anyone who happens to be listening. In the case of a SlitherSense deployment, the 'things' that could be listening are the app and the gateway.

\n

Both the SlitherSense app (when its running in the foreground on the mobile device) and the gateway will listen for these broadcasts from the device and convert the data into human readable information such as temperature, humidity, and system identifier. Once the app or the gateway hears a broadcast, it will 'gate' that data up to the SlitherSense platform in the cloud. The frequency of this gating is once every five minutes, per-device.

\n

User Interface (UI) Overview

\n

The following diagram shows the components of the SlitherSense User Interface available at slithersense.io.

\n

The general components are:

\n
    \n
  1. Locations
    2. \n
  2. Vivaria
    3. \n
  3. Storage Units
    4. \n
  4. Devices
    5. \n
  5. Pets
    6. \n
\n\n\"UI\n

Additional Info

\n

Further details on how the individual components in the system work can be found in their respective help pages on the left side of the screen.

\n", "url": "https://docs.slithersense.com/overview/", "title": "Overview", "summary": "Overview of the SlitherSense System", "date_modified": "2023-02-02T07:50:45.000Z" }, { "id": "https://docs.slithersense.com/gateway/", "content_html": "

Overview

\n

The SlitherSense (SS) gateway has the job of listening for data from SS sensors and getting that data up into the SS platform up in the Internet. The gateway connects to your home network using standards-based 2.4 GHz Wi-Fi. The device, once successfully connected to your home network, will establish a persistent connection to the SlitherSense cloud. This allows for rapid communication between the on-premise devices and the back-end 'brain' of the system. As a side note, it also reduces bandwidth utilization as it does not have to do full exchange of cryptographic key information (TLS info) each time it needs to push data up to the platform.

\n

Physical

\n

The SS gateway is enclosed in a box that is approximately 6.5cm square, 2.5"square.
\nThe enclosure has flanges with pre-drilled holes for mounting the gateway. The gateway ships with adhesive tape for mounting rather than screws.
\n\n

\n

Power

\n

Power to the gateway is provided by standard 5 volt USB using a type-C connector. The cable and power adapter are available as options in the SS Shop. Any standard 5V USB charger will work to run the gateway. The gateway consumes approximately 100 mA in normal operation.

\n

Wi-Fi

\n

The gateway is IEEE 802.11 b/g/n-compliant and only operates on the 2.4 GHz spectrum. 5 GHz operation is not supported.

\n

Capacity and Operation

\n

The SSGW1 gateway can gate data for 100 devices. It's important to note that two gateways does not mean 200 devices. Since the devices are mindlessly beaconing their sensor readings, any gateway that hears the data will gate it to the SS platform. Sufficient distance between gateways should be used in the event you have a geographically disperse deployment. The maximum receiving distance of the gateway to the devices is approximately 100 meters in open air; through several walls of a standard American home.
\nThe gateway will send data to the cloud from each sensor no faster than once per five minutes. This is to save on data; both storage and transmission.

\n

Setup

\n

The gateway must be configured for use. The only configuration required is to provide the gateway with the name and password/passphrase for your wireless (Wi-Fi) network. This configuration is done using the SlitherSense app on either iOS or Android.

\n
    \n
  1. Join your mobile device to the Wi-Fi network you wish to connect the gateway to.
    \n
    2. \n
  2. Apply power to the gateway. After 5 seconds, the light on the gateway should be blinking red every second indicating that it does not know what network to connect to.
    3. \n
  3. Open the app.
    4. \n
  4. Click Setup Gateway at the top.
    \n
    5. \n
  5. You should see the name of the network pre-populated.
    \n
    6. \n
  6. Type in the password for the network and click CONNECT.
    \n
    7. \n
  7. Wait for feedback, it has a 90 second timeout. If all worked properly you should see a message informing you that the operation was successful.
    \n
    8. \n
\n

NOTE: If you typed the password wrong, you'll have to reset the gateway and try again.

\n

Blinking LED Colors

\n

There is an LED built into the gateway that blinks to indicate what state the gateway is in. You can refer to the table below for information on what the gateway is doing.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ColorColorFrequencyDescription
Red1 secWaiting for Wi-Fi configuration information
Blue1 secBooting, attempting to join Wi-Fi
Teal1 secNTP - time is being synchronized.
Purple1 secFactory reset waiting 5 seconds
White1 secOver-the-air firmware update occurring
Green15 secAll good, nominal operation.
Yellow1 secRebooting
\n

Ports and Protocols

\n

The gateway uses the following ports and protocols to communicate with the SlitherSense platform on the Internet. No connections are initiated to the gateway; all on-going communication is initiated by the gateway first.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ProtocolPortDescription
TCP8883Secure Message Queue Telemetry Transport (MQTT)
used for real-time communication from the gateway to the SS platform.
UDP123Network Time Protocol (NTP)
used to synchronize time on the gateway so that the sensor readings are associated with the correct time.
TCP443Transport Layer Security (TLS) encrypted HTTP
The gateway will periodically check for firmware updates. It does this with standards-based secure HTTP.
\n

Factory Reset

\n

The gateway has a small tactile switch accessible through the hole labeled FACTORY to the left of the power connector. If you depress the switch for 5 seconds, the system will undergo a factory reset and reboot. While the button is depressed, the LED will blink PURPLE to indicate the system is currently counting down to factory reset; the switch must remain depressed to reset. After it boots back up, the LED will blink red to indicate that it does not have any saved Wi-Fi network information to connect to.

\n\n

Get Help

\n

You can reach the SS team through one of the following:

\n\n", "url": "https://docs.slithersense.com/gateway/", "title": "Hardware | Gateway", "summary": "SlitherSense Gateway", "date_modified": "2023-02-02T07:50:40.000Z" }, { "id": "https://docs.slithersense.com/sensors/", "content_html": "

This page has information on the SlitherSense devices.

\n\n

\n

SS1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Desc.: The SS1 device is a Bluetooth Low Energy temperature and humidity sensor.
Battery: The SS1 contains an internal high-capacity lithium-ion cell. This battery is not replaceable or serviceable.
Opening: To avoid risk of injury, the SS1 should not be opened.
Life: The beaconing and sensing configuration on the SS1 results in a calculated lifetime of 105 months, approximately 8.75 years, from the time the device is turned on.
Power Switch: The SS1 has a tactile switch on the back of the device that can be used to power on and off the device. Depress the button for 5 seconds to turn off (the red LED will blink 8 times prior to power down). Depress for 3 seconds to turn on.
Temperature Accuracy: +/- 0.3° Celsius
Humidity Accuracy: +/- 2% Relative Humidity
\n

\n

TBD

\n

Do you have an idea for a device with a particular sensor that would be helpful? Drop us a note at hello@slithersense.com.

\n

Thoughts we've had:

\n\n", "url": "https://docs.slithersense.com/sensors/", "title": "Hardware | Sensors", "summary": "SlitherSense Sensors", "date_modified": "2023-02-02T07:50:30.000Z" }, { "id": "https://docs.slithersense.com/app-ios/", "content_html": "

App Info

\n

The IOS and Android applications serve four purposes:

\n
    \n
  1. \n

    The first purpose is to show you real time information about the devices that are near your phone. You will be able to see the current values for the sensors in SlitherSense devices by opening the app and waiting for the device to be heard. In the following image, device with ID SS1-298981 has current readings of 30.86 Celcius and 24.84% relative humidity.
    \n

    \n
    2. \n
  2. \n

    The second purpose of the app is to send that 'heard' data up to the platform on the internet. The application will send data to the internet once every 5 minutes however, the data in the list of devices shown in the application will update in real time.

    \n
    3. \n
  3. \n

    The third purpose of the application is to provide you with a message to transmit the credentials for your home Wi-Fi network to the SlitherSense gateway. Please consult the Gateway documentation for information on this particular feature.
    \n

    \n
    4. \n
  4. \n

    A fourth use of the application is to provide you with a quick method to add a device to your account, or, to claim a device. If you tap on a device in the list of heard devices it will take you to the platform website and pre-populate the device field.
    \n\n

    \n
    5. \n
\n

There is a button at the bottom of the application. This can be used to take you to the platform website.
\n

\n", "url": "https://docs.slithersense.com/app-ios/", "title": "App | iOS", "summary": "SlitherSense iOS App", "date_modified": "2023-02-02T07:50:20.000Z" }, { "id": "https://docs.slithersense.com/app-android/", "content_html": "

App Info

\n

The IOS and Android applications serve four purposes:

\n
    \n
  1. \n

    The first purpose is to show you real time information about the devices that are near your phone. You will be able to see the current values for the sensors in SlitherSense devices by opening the app and waiting for the device to be heard. In the following image, device with ID SS1-298981 has current readings of 70.21 fahrenheit and 36.88% relative humidity.
    \n

    \n
    2. \n
  2. \n

    The second purpose of the app is to send that 'heard' data up to the platform on the internet. The application will send data to the internet once every 5 minutes however, the data in the list of devices shown in the application will update in real time.

    \n
    3. \n
  3. \n

    The third purpose of the application is to provide you with a message to transmit the credentials for your home Wi-Fi network to the SlitherSense gateway. Please consult the Gateway documentation for information on this particular feature.
    \n

    \n
    4. \n
  4. \n

    A fourth use of the application is to provide you with a quick method to add a device to your account, or, to claim a device. If you tap on a device in the list of heard devices it will take you to the platform website and pre-populate the device field.
    \n\n

    \n
    5. \n
\n

There is a cloud icon at the bottom of the application. This can be used to take you to the platform website.
\n

\n", "url": "https://docs.slithersense.com/app-android/", "title": "App | Android", "summary": "SlitherSense Android App", "date_modified": "2023-02-02T07:50:15.000Z" }, { "id": "https://docs.slithersense.com/ui-overview/", "content_html": "

The SlitherSense user interface, available at slithersense.io, is your primary location to interact with your deployment of the SlitherSense system. This is where you will go to view data and configure your system to ensure you are alerted whenever any problems arise. The various components of the user interface are organized as shown in the following diagram.

\n

Component Diagram

\n\"Overview \n

There are individual pages of documentation for each of these components.

\n\n", "url": "https://docs.slithersense.com/ui-overview/", "title": "UI | Overview", "summary": "SlitherSense UI", "date_modified": "2023-02-02T07:50:12.000Z" }, { "id": "https://docs.slithersense.com/pets/", "content_html": "

Overview

\n

Pets are your critters. Pets get created in the system and are then assigned to a vivarium where they live. The devices also associated with that vivarium are used to ensure the environment of that vivarium meets the needs of the type of the pet that is in the vivarium.

\n

See All

\n

To access the list of Pets, click Pets -> All Pets.
\nhttps://slithersense.io/pets
\n
\n

\n

You will see a table that lists all Vivaria/Terraria and Storage Units organized by Location.
\n

\n

There is an actions column on the table with actions for:
\n

\n\n

Creation and Edit

\n

To add a new pet click Add a Pet.
\nYou'll be presented with a form to enter the pet's name:
\n
\nEnter the name and click Save
\nYou'll then be taken to the pet's detail page where you can specify the pet type, e.g. bearded dragon or leopard gecko, etc. and its birthday. When you use the pencil icon at /pets it will take you to this same edit view:
\n

\n", "url": "https://docs.slithersense.com/pets/", "title": "UI | Pets", "summary": "SlitherSense UI pets", "date_modified": "2023-02-02T07:50:10.000Z" }, { "id": "https://docs.slithersense.com/devices/", "content_html": "

Overview

\n

The devices area of the user interface is for administration and view of devices that you have claimed.

\n

See All

\n

To access the list of Devices, click Devices -> All Devices.
\nhttps://slithersense.io/devices
\n\n

\n

You will see a table that lists all Vivaria/Terraria and Storage Units organized by Location.
\n

\n

There is an actions column on the table with actions for:
\n

\n\n

Claiming a Device

\n

https://slithersense.io/device/add\nDevices must be claimed by you to use in your SlitherSense deployment.
\nClick on Devices -> Add Device to add a device.
\nThe device's six-digit identifier is required to add it to your account. In the following image, the six-digit ID of the device is 340228. (Click to enlarge)
\n

\n

NOTE: You can use the SlitherSense app on iOS or Android to quickly add devices to your account.
\n

\n

View Device Data

\n

if you click on the eye icon for a device at /devices it will take you to the data view of that device.
\n
\nThe following is an example of a heat lamp failure that occurred while developing SlitherSense.
\n

\n

Edit a Device

\n

When you click the pencil icon in /devices you will see the following:
\n

\n

The following table describes the settings.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SettingDescription
IDThis is a read-only field in the form. The six-digit identifier of the device is not modifiable.
Device NameUser-defined name of the device. Feel free to call the device whatever you want.
Offline AlertIf checked, the SlitherSense platform will generate an alert if this device has not published data within the last six hours.
\n

Data Storage

\n

The SlitherSense system retains 1 month (four weeks) of data per-device by default. This setting is configurable however credits will be consumed per-month by doing so at a rate of (1 * data-storage-months) per month. Here's an example of how this works:

\n
    \n
  1. You add/claim a device.
    2. \n
  2. You set the data retention duration to 6 months for this one device.
    3. \n
  3. You will be charged 6 credits per month to store that data for this device on the first of the next month.\nThe minimum data retention duration is 1 month (four weeks, 28 days) which will consume one credit per month for that device.
    4. \n
\n", "url": "https://docs.slithersense.com/devices/", "title": "UI | Devices", "summary": "SlitherSense UI devices", "date_modified": "2023-02-02T07:50:00.000Z" }, { "id": "https://docs.slithersense.com/users/", "content_html": "

Overview

\n

The account that you use to sign up for a SlitherSense is considered a root account. Within the root account you can create additional user accounts. These user accounts can either be administrators of that root account or read-only users. For example, if you are a parent and you want your children to be able to monitor and respond to events within the SlitherSense deployment you can create a read-only user that your child can log into to access the data however, they will not be able to modify anything. The root account that is used to sign up for SlitherSense is the only account that has access to the available credits of the account. Also, this account cannot be disabled or deleted. User accounts that are created by you, the root account, can be deleted.

\n

\n

See All Users

\n

To access the list of Users, click Users -> All Users.
\nhttps://slithersense.io/users
\nNOTE:You will not be able to access the users information if you are not an administrator of the account.

\n

\n

\n

You will see a table that lists all users.
\n

\n

You can click on the pencil icon to edit a user or the X icon to delete.
\n

\n

The root account is the primary owner of the SlitherSense deployment. That account cannot be deleted.
\nYou will not see actions for the account you are currently logged in as. If you wish to modify your own profile, click on the user icon in the top right and click profile.
\n

\n

Edit User

\n

From /locations if you click on the 'pencil' icon it will take you to the edit profile form for the user. You can change various attributes about the user from here, including the user's password.
\n

\n", "url": "https://docs.slithersense.com/users/", "title": "UI | Users", "summary": "SlitherSense UI Users", "date_modified": "2023-02-02T07:40:50.000Z" }, { "id": "https://docs.slithersense.com/locations/", "content_html": "

Overview

\n

Locations are a general purpose organizational unit that serves the purpose of keeping the data within SlitherSense organized. A location is the top of the hierarchy. Locations can contain storage units and vivaria. For example, if you were a zoo, you could have locations such as reptile house, frog house, snake house, etc. Within those locations would be individual vivaria for each animal. Another example would be a large house with multiple rooms that had vivaria in each room. For example, bedroom one, bedroom two, living room, dining room, these could all be locations. The user interface is organized in such a way that vivaria in the same location are grouped together. Similarly storage units in the same location will be grouped with vivaria in the same location.\nWhenever you sign up for SlitherSense, a default location and vivarium are created for you. You can edit the name of these as well.

\n

See All Locations

\n

To access the list of Locations, click Locations -> All Locs, Vivs, and SUs.
\nhttps://slithersense.io/locations
\n
\n

\n

You will see a table that lists all Vivaria/Terraria and Storage Units organized by Location.\n\nWhen viewing all locations and vivaria; if there are no vivaria or storage units in a location, it will say "No Vivaria" or "No Storage Units".

\n

You can click on the the pencil icon to edit a location.
\n

\n

Editing a Location

\n

The edit form for a location includes attributes for location and latitude, longitude. A future planned release of the User Interface will provide mapping features.
\n

\n", "url": "https://docs.slithersense.com/locations/", "title": "UI | Locations", "summary": "SlitherSense UI Locations", "date_modified": "2023-02-02T07:40:40.000Z" }, { "id": "https://docs.slithersense.com/vivaria/", "content_html": "

Overview

\n

Vivaria and terraria (the plural forms of vivarium and terrarium respectively) are the principal organizational unit within SlitherSense. A vivarium will house one or more pets, up to four, and several SlitherSense devices. The assignment of pets and devices to a vivarium is done in the vivarium edit screen in the user interface.\nWhen you create your SlitherSense account a Default Vivarium will be created in a location called Default Location. This Vivarium is not deletable however you can rename it as you see fit.

\n

There is a tight coupling between the pet that is associated with a vivarium and the thresholds for the zones. For example, if you create a pet that is a standard bearded dragon (Pogona Vitticeps). And you then associate this new pet with this vivarium and click the button Set Pet Type Recs the upper and lower thresholds for temperature and humidity will be set on each zone (BASK, WARM, COOL) based on the type of the pet; Bearded Dragons like heat so the BASK zone will be particularly warm with relatively low humidity. A frog, for example, would have a much higher humidity recommendation.

\n

Zones

\n

A vivarium is divided into logical zones, either two or three zones. A two Zone vivarium would have a COOL zone and a BASK zone. A three zone vivarium would have a BASK zone, a WARM zone, and a COOL zone.
\nWhenever you create a new vivarium you will specify the number of zones that are contained within that vivarium; this setting is not modifiable. When you edit a vivarium, based on the number of zones you specified when it was created, you can configure the type of zone, for example WARM or COOL, as well as the upper and lower thresholds for both temperature and humidity within that zone.
\nYou will also assign a SlitherSense device to that particular zone. As temperature and humidity readings are received by the system it will determine the upper and lower bounds for temperature and humidity in a particular vivarium and then Alert in the event thresholds have been violated

\n

Nighttime

\n

There is a setting for nighttime and timezone when editing a vivarium. This time should be set to the time of day that any lamps above the vivarium are turn off. This will ensure that alerts are not generated for a zone violation when its nighttime.

\n

See All

\n

To access the list of Vivaria, click Locations -> All Locs, Vivs, and SUs.
\nhttps://slithersense.io/locations
\n
\n

\n

You will see a table that lists all Vivaria/Terraria and Storage Units organized by Location.
\n

\n

You can click on the eye icon to view the vivarium or the pencil icon to edit it.
\n

\n

Access Data

\n

From /locations if you click on the 'eye' icon it will take you to the view for the vivarium that shows the data from all devices associated.
\n
\nYou can also access this view from the dashboard page by clicking on View Vivarium:
\n

\n

Why "Vivarium" instead of "Terrarium"?

\n

See Frequently Asked Questions

\n

Edit Settings

\n

There are many configuration options available for vivaria. Recall from previous documentation that both pets and devices are 'stored' in vivaria. When you edit a vivarium, you will specify the type for each zone, assign a device to each zone, assign any pets to that vivarium, and verify or set the upper and lower threshold for both temperature and humidity.
\nTo edit the settings for the viv, click on the pencil icon in /locations.

\n

General Settings

\n


\nWithin general settings you can modify:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SettingDescription
NameThe name of the vivarium.
LocationThe location this vivarium is contained in.
TypeThis is a generic field for your use to denote the type of vivarium, e.g. glass.
CapacityThis is a generic field for your use to denote the volume of the vivarium. Units are not specific.
H W LThis is a generic field for your use to denote the height, width, and length of the vivarium. Units are not specific.
Hide from dashboardIf this checkbox is enabled, this vivarium will not be shown on the main dashboard.
Send AlertsIf this checkbox is enabled, alerts will be generated for violations in this vivarium.
\n

Nighttime Settings

\n


\nWithin Nighttime settings you can modify:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SettingDescription
TimezoneThe timezone that the vivarium is in. Or, the timezone that the sunset setting is associated with.
SunsetThe time of day that the daytime lamps turn off in the vivarium
Nighttime Min. TempThe absolute minimum temperature that can be experienced during nighttime.
SunriseThe time of day that the daytime lamps turn on in the vivarium
\n

Pet Settings

\n


\nWithin pet settings you can modify:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SettingDescription
PetSelect a pet to associate it with this vivarium.
\n

The Set Pet Type Recs button will query the SlitherSense pet type database and apply the recommended upper and lower temperature and humidity thresholds for the various zones.

\n

Zone Settings

\n

Zones in the vivarium are numbered left to right as if you were looking at the vivarium.
\nFor example:
\n
\nA zone can be of any type, i.e. BASK, WARM, COOL. When you click Set Pet Type Recs under the the pet that is associated, the recommendation for high/low temp/humidity for each zone will be set for you. You are free to modify these settings, the button will only apply the recommendations for you to agree with or modify.

\n


\nWithin each zone (one, two, three) you will modify:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SettingDescription
DeviceThe SlitherSense device that is in this zone.
Zone TypeBASK, WARM, COOL -- This is particularly used when Set Pet Type Recs is used. You are free to have, for example, one BASK and two COOL zones.
Temp HighThis is the maximum daytime temperature that should be experienced in this zone.
Temp LowThis is the minimum daytime temperature that should be experienced in this zone.
Humidity HighThis is the maximum daytime humidity that should be experienced in this zone.
Humidity LowThis is the minimum daytime humidity that should be experienced in this zone.
\n

Vivaria zones are typically laid out in the following manner, either left to right or right to left, creating two or three zones that transition from BASK to COOL.
\n

\n", "url": "https://docs.slithersense.com/vivaria/", "title": "UI | Vivaria", "summary": "SlitherSense UI Vivaria", "date_modified": "2023-02-02T07:40:30.000Z" }, { "id": "https://docs.slithersense.com/storage-units/", "content_html": "

Overview

\n

Storage units are like vivariums however, there are no zones. You can associate multiple devices with a single storage unit. That storage unit will have a single "zone". That zone will have upper and lower temperature and humidity thresholds. If any device within the storage unit violates those thresholds an alert will be generated.

\n

See All Storage Units

\n

To access the list of Storage Units, click Locations -> All Locs, Vivs, and SUs.
\nhttps://slithersense.io/locations
\n
\n

\n

You will see a table that lists all Vivaria/Terraria and Storage Units organized by Location.
\n

\n

You can click on the the pencil icon to edit a storage unit.
\n

\n

Adding a Storage Unit

\n

Click Locations -> Add Storage Unit to add a storage unit.
\n

\n

Editing a Storage Unit

\n

The edit form for a storage unit includes attributes.
\n

\n

The following settings are editable:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SettingDescription
Storage Unit NameThe name of the storage unit.
LocationThe location where this storage unit is.
TypeGeneric, user-defined type of storage.
NotesGeneric, user-defined notes for the storage unit.
DevicesSelect one or more devices that are contained within this storage unit.
Hold CTRL to select multiple.
Temp High/LowThe maximum and minimum temperature allowed in the storage unit. When the temperature goes above the max or below the min, an alert will be generated.
Humidity High/LowThe maximum and minimum humidity allowed in the storage unit. When the humidity goes above the max or below the min, an alert will be generated.
\n", "url": "https://docs.slithersense.com/storage-units/", "title": "UI | Storage Units", "summary": "SlitherSense UI Storage Units", "date_modified": "2023-02-02T07:40:25.000Z" }, { "id": "https://docs.slithersense.com/alerts/", "content_html": "

Overview

\n

Whenever data is received by a gateway that contains telemetry information from a device, it will be checked against the vivarium or storage unit the device is associated with. If the thresholds for a particular zone or a storage unit are violated, an alert will be generated. The alert will show up in the all alerts area of the user interface.
\nAny users that have Notify via Email and/or Notify via SMS/Text enabled will receive that alert to their email and/or phone number.\nYou can enable/disable the delivery of alerts via email/sms for yourself in your profile settings.
\n

\n

NOTE: Alert notifications will consume credits. Please see the documentation page for credits for more information.

\n

View Alerts

\n

To access the list of Alerts, click Alerts -> All Alerts or Active Alerts\nActive Alerts are alerts that have not been resolved.
\nAll Alerts are all alerts that have been generated, regardless of resolution or acknowledgment.
\n
\n

\n

For Active Alerts, you will see a list of all alerts that still in violation. Meaning, they are not resolved. If an temperature threshold is violated an alert is generated, if the temperature comes back in range, the alert will resolve itself however it will still be viewable in the All Alerts area.\n

\n

The following table describes the columns in the Alerts table:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ColumnDescription
Date/TimeThe date/time the alert was generated, in your location timezone.
Alert TextThe text of the alert. This is the same text that will be emailed/texted to you when the alert is generated, if configured to do so.
Alert Acked ByThe name of the person who acknowledged the alert. See acknowledging an alert.
Alert Ack MsgThe user-defined notes when acknowledged.
Alert Acked AtThe date/time the user acknowledged the alert.
Alert Resolved AtThe date/time the alert resolved. This is based on the threshold being no longer in violation.
ActionsYou can acknowledge an alert by clicking the check-mark or delete it with the X
\n

\n

Acknowledging an Alert

\n

Alerts can be acknowledged by any user which means, "I've seen this alert and here's what I'm doing about it." When a user clicks the check-mark to acknowledge the alert, they can enter a note that will be associated with the acknowledgment.
\n
\n

\n", "url": "https://docs.slithersense.com/alerts/", "title": "UI | Alerts", "summary": "SlitherSense UI Alerts", "date_modified": "2023-02-02T07:40:20.000Z" }, { "id": "https://docs.slithersense.com/credits/", "content_html": "

Overview of Credits

\n

Unfortunately, the SlitherSense platform costs money to operate and your use of the platform cannot be free forever. There are certain aspects of the system that cost money to execute. For example, sending a text message cost a certain amount of money. The SlitherSense team are not fans of recurring subscriptions that charge you money without your explicit approval. Therefore, the SlitherSense system operates using a credit model. Various actions of the system will deduct credits from your account. The table below shows the number of credits consumed for certain tasks. All new accounts will start with a bucket of credits that come with the purchase of the equipment.

\n

The number of credits provided with new accounts that are of normal size and tuned to lower alerts should provide several years of no-fee use.

\n

The root account is the only user that can access the credit information as well this is the only user that can refresh credits. Credits can be purchased in bulk from the SlitherSense shop.

\n

Viewing Credits

\n

As the root user, view your profile information and you will see the remaining credits at the bottom.
\n

\n

Exhausted all Credits

\n

When you have exhausted the number of credits in your account, you will receive an alert:

\n

\n

Purchasing Credits

\n

You can head over to shop.slithersense.com to purchase credits in bulk.

\n

Credit Fee Table

\n

The following table lists the credit 'cost' of various parts of the system.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Action/ThingCredit FeeDescription
Alert (Email)1An alert that generates an email will consume one credit. This is per user that has alerting enabled.
Alert (SMS/Text)2An alert that generates a text message (SMS) will consume two credits. This is per user that has alerting enabled.
Data Retention1/device/monthThe SlitherSense system keeps 4 weeks of device data by default. You can increase this amount in the per-device settings. The system will consume one credit per-device-month of storage per month. See data storage for a more in-depth explanation.
\n", "url": "https://docs.slithersense.com/credits/", "title": "UI | Credits", "summary": "Credits", "date_modified": "2023-02-02T07:40:17.000Z" }, { "id": "https://docs.slithersense.com/public-api/", "content_html": "

Overview of the Public API

\n

At the request of a few users, we have enabled the ability to query sensor data via publicly accessible API. The sensor data can be queried per-device using a user-specific API key that is generated at account creation.

\n

Your API key is something you should keep safe to avoid exposure of your sensor data.

\n

API Key

\n

To get started with the API you will need to know your API key. Head to https://slithersense.io/account and scroll down to the API Key section.

\n

\n

Enable Access

\n

You must enable public API access for each device you wish to query via API.
\nView the Settings for the device by either clicking the gear icon when viewing the device data or going to https://slithersense.io/devices and clicking the pencil/paper icon.
\nCheck the box for Public Data Access

\n

\n

Querying Sensor Data

\n

With your API Key and public data access enabled, you can send an HTTP GET request to
\nhttps://slithersense.io/api/public/device/<DEVICE_UUID>?key=<API_KEY>
\nto query data about the device with UUID <DEVICE_UUID> using API key <API_KEY>.

\n

\n", "url": "https://docs.slithersense.com/public-api/", "title": "UI | Public API", "summary": "Public API", "date_modified": "2023-02-02T07:40:16.000Z" }, { "id": "https://docs.slithersense.com/help/", "content_html": "

You can reach the SS team through one of the following:

\n\n", "url": "https://docs.slithersense.com/help/", "title": "Get Help", "summary": "Get Help", "date_modified": "2023-02-02T07:40:15.000Z" }, { "id": "https://docs.slithersense.com/faq/", "content_html": "

FAQ List

\n\n

\n

Why "Vivarium" instead of "Terrarium"

\n

I'm occasionally asked why I used vivarium and vivaria rather than terrarium and terraria. I struggled with this one a bit; I've always used "terrarium" until I started SlitherSense and forced myself to learn the definitions.

\n

The folks over at terrariumtribe.com sum it up nicely with:

\n
So, what is the difference between a terrarium and a vivarium?  Though\nboth environments can look very similar in terms of plants and earth,\nterrariums are designed to raise plants, and vivariums are designed\nprimarily to be a habitat for an animal.\n
\n

and

\n
...there are lots of different “ariums,” and each describes a different\nenvironment. Terrarium means land, and aquarium means water, for example.\n\nThen we have vivarium, which roughly translates to “place of life.”\n
\n

https://terrariumtribe.com/terrarium-vs-vivarium-explained/

\n

\n

How can I reach you?

\n

You can reach the SS team through one of the following:

\n\n

\n

I'm not getting alerts, what's up?

\n

Some things to check:

\n\n", "url": "https://docs.slithersense.com/faq/", "title": "Frequently Asked Questions (FAQ)", "summary": "Frequently Asked Questions", "date_modified": "2023-02-02T07:40:10.000Z" } ] }