Pelican Wireless Help Center

https://www.pelicanwireless.com/help-center/
Admin
A comprehensive help center providing support and documentation for Pelican Wireless products and...
Tokens:278,360
Snippets:563
Trust Score:7.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### OpenAPI Documentation for Pelican Wireless

Source: https://www.pelicanwireless.com/help-center/how-do-i-install-a-pelican-ethernet-gateway

This section likely contains information or links to OpenAPI documentation for Pelican Wireless products and services. OpenAPI specifications allow developers to understand and interact with APIs programmatically.

```OpenAPI
## OpenAPI
  * OpenAPI
```

--------------------------------

### Get Thermostat History Data (curl)

Source: https://www.pelicanwireless.com/help-center/thermostathistory-attributes

This example demonstrates how to retrieve historical temperature data for all thermostats using a GET request with curl. It specifies the start and end dates, and requests the thermostat name, temperature, and timestamp.

```curl
curl -Ls "https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=ThermostatHistory&selection=startDateTime:2025-04-23T00:00;endDateTime:2025-04-23T23:59;&value=name;temperature;timestamp"
```

--------------------------------

### Get Thermostat Data

Source: https://www.pelicanwireless.com/help-center/user-attributes

Retrieves temperature, humidity, and CO2 levels for a thermostat named 'Lobby'. This example demonstrates how to make a GET request to the API and process the response.

```PHP
if ($result->{'success'}) {
    print "Success: $result->{'message'}\n";
} else {
    print "Error: $result->{'message'}\n";
}
```

```Python
import requests

url = "https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=Thermostat&selection=name:Lobby;&value=temperature;humidity;co2Level"
response = requests.get(url, verify=False)

if response.status_code == 200:
    print("Success:", response.text)
else:
    print("Error:", response.status_code)
```

```Node.js
const https = require('https');

const url = 'https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=Thermostat&selection=name:Lobby;&value=temperature;humidity;co2Level';

https.get(url, { rejectUnauthorized: false }, (resp) => {
  let data = '';

  // Collect data chunks
  resp.on('data', (chunk) => {
    data += chunk;
  });

  // Handle the complete response
  resp.on('end', () => {
    if (resp.statusCode === 200) {
      console.log('Success:', data);
    } else {
      console.log('Error: HTTP', resp.statusCode);
    }
  });
}).on('error', (err) => {
  console.error('Error:', err.message);
});
```

--------------------------------

### OpenAPI Documentation for Pelican Wireless

Source: https://www.pelicanwireless.com/help-center/what-is-optimum-start

This section likely contains information or links to OpenAPI documentation for Pelican Wireless products and services. OpenAPI specifications allow developers to understand and interact with APIs programmatically.

```OpenAPI
## OpenAPI
  * OpenAPI
```

--------------------------------

### OpenAPI Documentation for Pelican Wireless

Source: https://www.pelicanwireless.com/help-center/how-do-i-install-a-pelican-cellular-gateway

This section likely contains information or links to OpenAPI documentation for Pelican Wireless products and services. OpenAPI specifications allow developers to understand and interact with APIs programmatically.

```OpenAPI
## OpenAPI
  * OpenAPI
```

--------------------------------

### Get Thermostat Data

Source: https://www.pelicanwireless.com/help-center/thermostatschedule-attributes

Retrieves temperature, humidity, and CO2 levels for a thermostat named 'Lobby'. This example demonstrates how to make a GET request to the API and process the response.

```PHP
if ($result->{'success'}) {
    print "Success: $result->{'message'}\n";
} else {
    print "Error: $result->{'message'}\n";
}
```

```Python
import requests

url = "https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=Thermostat&selection=name:Lobby;&value=temperature;humidity;co2Level"
response = requests.get(url, verify=False)

if response.status_code == 200:
    print("Success:", response.text)
else:
    print("Error:", response.status_code)
```

```Node.js
const https = require('https');

const url = 'https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=Thermostat&selection=name:Lobby;&value=temperature;humidity;co2Level';

https.get(url, { rejectUnauthorized: false }, (resp) => {
  let data = '';

  // Collect data chunks
  resp.on('data', (chunk) => {
    data += chunk;
  });

  // Handle the complete response
  resp.on('end', () => {
    if (resp.statusCode === 200) {
      console.log('Success:', data);
    } else {
      console.log('Error: HTTP', resp.statusCode);
    }
  });
}).on('error', (err) => {
  console.error('Error:', err.message);
});
```

--------------------------------

### OpenAPI Documentation for Pelican Wireless

Source: https://www.pelicanwireless.com/help-center/how-do-i-wire-a-pearl-to-start-an-exhaust-fan

This section likely contains information or links to OpenAPI documentation for Pelican Wireless products and services. OpenAPI specifications allow developers to understand and interact with APIs programmatically.

```OpenAPI
## OpenAPI
  * OpenAPI
```

--------------------------------

### Get Thermostat Data

Source: https://www.pelicanwireless.com/help-center/powerschedule-attributes

Retrieves temperature, humidity, and CO2 levels for a thermostat named 'Lobby'. This example demonstrates how to make a GET request to the API and process the response.

```PHP
if ($result->{'success'}) {
    print "Success: $result->{'message'}\n";
} else {
    print "Error: $result->{'message'}\n";
}
```

```Python
import requests

url = "https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=Thermostat&selection=name:Lobby;&value=temperature;humidity;co2Level"
response = requests.get(url, verify=False)

if response.status_code == 200:
    print("Success:", response.text)
else:
    print("Error:", response.status_code)
```

```Node.js
const https = require('https');

const url = 'https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=Thermostat&selection=name:Lobby;&value=temperature;humidity;co2Level';

https.get(url, { rejectUnauthorized: false }, (resp) => {
  let data = '';

  // Collect data chunks
  resp.on('data', (chunk) => {
    data += chunk;
  });

  // Handle the complete response
  resp.on('end', () => {
    if (resp.statusCode === 200) {
      console.log('Success:', data);
    } else {
      console.log('Error: HTTP', resp.statusCode);
    }
  });
}).on('error', (err) => {
  console.error('Error:', err.message);
});
```

--------------------------------

### Get Thermostat Data

Source: https://www.pelicanwireless.com/help-center/mysites-attributes

Retrieves temperature, humidity, and CO2 levels for a thermostat named 'Lobby'. This example demonstrates how to make a GET request to the API and process the response.

```PHP
if ($result->{'success'}) {
    print "Success: $result->{'message'}\n";
} else {
    print "Error: $result->{'message'}\n";
}
```

```Python
import requests

url = "https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=Thermostat&selection=name:Lobby;&value=temperature;humidity;co2Level"
response = requests.get(url, verify=False)

if response.status_code == 200:
    print("Success:", response.text)
else:
    print("Error:", response.status_code)
```

```Node.js
const https = require('https');

const url = 'https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=Thermostat&selection=name:Lobby;&value=temperature;humidity;co2Level';

https.get(url, { rejectUnauthorized: false }, (resp) => {
  let data = '';

  // Collect data chunks
  resp.on('data', (chunk) => {
    data += chunk;
  });

  // Handle the complete response
  resp.on('end', () => {
    if (resp.statusCode === 200) {
      console.log('Success:', data);
    } else {
      console.log('Error: HTTP', resp.statusCode);
    }
  });
}).on('error', (err) => {
  console.error('Error:', err.message);
});
```

--------------------------------

### OpenAPI Documentation for Pelican Wireless

Source: https://www.pelicanwireless.com/help-center/how-do-i-schedule-events-for-multiple-rooms_seq_no=2

This section likely contains information or links to OpenAPI documentation for Pelican Wireless products and services. OpenAPI specifications allow developers to understand and interact with APIs programmatically.

```OpenAPI
## OpenAPI
  * OpenAPI
```

--------------------------------

### OpenAPI Documentation for Pelican Wireless

Source: https://www.pelicanwireless.com/help-center/how-many-heat-stages-do-i-select-for-a-thermostat

This section likely contains information or links to OpenAPI documentation for Pelican Wireless products and services. OpenAPI specifications allow developers to understand and interact with APIs programmatically.

```OpenAPI
## OpenAPI
  * OpenAPI
```

--------------------------------

### GET Daily Energy Consumption Data (Node.js)

Source: https://www.pelicanwireless.com/help-center/powerusage-attributes

Fetches daily energy consumption data for March 2025 using Node.js's https module. This example demonstrates making an HTTPS GET request to the Pelican API and handling the response data.

```javascript
const https = require('https');

const url = 'https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=PowerUsage&selection=startDateTime:2025-03-01T00:00:00Z;endDateTime:2025-03-31T23:59:59Z;duration:day;&value=name;kWh;kW;timestamp';

https.get(url, { rejectUnauthorized: false }, (resp) => {
  let data = '';

  // Collect data chunks
  resp.on('data', (chunk) => {
    data += chunk;
  });

  // Handle the complete response
  resp.on('end', () => {
    if (resp.statusCode === 200) {
      console.log('Success:', data);
    } else {
      console.log('Error: HTTP', resp.statusCode);
    }
  });
}).on('error', (err) => {
  console.error('Error:', err.message);
});

```

--------------------------------

### Get Thermostat Attributes (Perl)

Source: https://www.pelicanwireless.com/help-center/user-attributes

Retrieves the current temperature, humidity, and CO2 level for a thermostat named 'Lobby' using the ClimateControl Perl module. Requires the ClimateControl module to be installed.

```perl
#!/usr/bin/perl -w

use strict;
use ClimateControl;
# You can request a copy of the ClimateControl Perl
# Module from Pelican Tech Support.
# Send an email to support@pelicanwireless.com

# Create a new ClimateControl object
my $cc = ClimateControl->new(
    'pelicandemosite@gmail.com',      # username
    'pelican',                        # password
    'demo.officeclimatecontrol.net'  # website
);

# Define the selection and attributes to retrieve
my $selection = { 'name' => 'Lobby' };
my $attrlist = ['temperature', 'humidity', 'co2Level'];

# Call getAttributes to retrieve the Thermostat data
my $result = $cc->getAttributes('Thermostat', $selection, $attrlist);

```

--------------------------------

### OpenAPI Documentation for Pelican Wireless

Source: https://www.pelicanwireless.com/help-center/how-many-cool-stages-do-i-select-for-a-thermostat

This section likely contains information or links to OpenAPI documentation for Pelican Wireless products and services. OpenAPI specifications allow developers to understand and interact with APIs programmatically.

```OpenAPI
## OpenAPI
  * OpenAPI
```

--------------------------------

### Get Thermostat Data (curl)

Source: https://www.pelicanwireless.com/help-center/mysites-attributes

Retrieves the current temperature, humidity, and CO2 level for a thermostat named 'Lobby' using a cURL command. This example demonstrates how to interact with the API to fetch specific thermostat attributes.

```curl
curl -Ls "https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=Thermostat&selection=name:Lobby;&value=temperature;humidity;co2Level"
```

--------------------------------

### OpenAPI Documentation for Pelican Wireless

Source: https://www.pelicanwireless.com/help-center/how-do-i-schedule-an-event-for-a-single-thermostat

This section likely contains information or links to OpenAPI documentation for Pelican Wireless products and services. OpenAPI specifications allow developers to understand and interact with APIs programmatically.

```OpenAPI
## OpenAPI
  * OpenAPI
```

--------------------------------

### OpenAPI Documentation for Pelican Wireless

Source: https://www.pelicanwireless.com/help-center/how-many-fan-stages-do-i-select-for-a-thermostat

This section likely contains information or links to OpenAPI documentation for Pelican Wireless products and services. OpenAPI specifications allow developers to understand and interact with APIs programmatically.

```OpenAPI
## OpenAPI
  * OpenAPI
```

--------------------------------

### GET Thermostat Events (cURL)

Source: https://www.pelicanwireless.com/help-center/thermostatevent-attributes

Retrieves upcoming events for a thermostat named 'Lobby' using cURL. This command fetches event details like ID, title, start time, and end time from the API.

```curl
curl -L "https://your-site-name.officeclimatecontrol.net/api.cgi?username=USERNAME&password=PASSWORD&request=get&object=ThermostatEvent&selection=name:Lobby;origin:all&value=eventId;title;startTime;endTime"
```

--------------------------------

### OpenAPI Documentation for Pelican Wireless

Source: https://www.pelicanwireless.com/help-center/how-do-i-wire-a-pearl-to-control-my-economizer

This section likely contains information or links to OpenAPI documentation for Pelican Wireless products and services. OpenAPI specifications allow developers to understand and interact with APIs programmatically.

```OpenAPI
## OpenAPI
  * OpenAPI
```

--------------------------------

### Get Thermostat Attributes (cURL)

Source: https://www.pelicanwireless.com/help-center/thermostatschedule-attributes

This example demonstrates how to retrieve the current temperature, humidity, and CO2 level for a thermostat named 'Lobby' using a cURL command. It requires a username, password, and the specific object and values to retrieve.

```cURL
curl -Ls "https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=ThermostatSchedule&selection=name:Lobby;&value=temperature;humidity;co2Level"
```

--------------------------------

### Python: Making HTTP Requests with requests

Source: https://www.pelicanwireless.com/help-center/can-i-disable-the-thermostats-internal-temperature-sensor

Provides an example of making HTTP requests in Python using the popular 'requests' library. This snippet shows how to send a GET request and process the JSON response, including error handling.

```python
import requests

try:
    response = requests.get('https://api.example.com/data')
    response.raise_for_status()  # Raise an exception for bad status codes
    data = response.json()
    print(data)
except requests.exceptions.RequestException as e:
    print(f'Error making request: {e}')
```

--------------------------------

### OpenAPI Documentation for Pelican Wireless

Source: https://www.pelicanwireless.com/help-center/can-i-pay-for-multiple-site-subscriptions-at-once

This section likely contains information or links to OpenAPI documentation for Pelican Wireless products and services. OpenAPI specifications allow developers to understand and interact with APIs programmatically.

```OpenAPI
## OpenAPI
  * OpenAPI
```

--------------------------------

### OpenAPI Documentation for Pelican Wireless

Source: https://www.pelicanwireless.com/help-center/how-do-i-set-an-individual-thermostat-schedule

This section likely contains information or links to OpenAPI documentation for Pelican Wireless products and services. OpenAPI specifications allow developers to understand and interact with APIs programmatically.

```OpenAPI
## OpenAPI
  * OpenAPI
```

--------------------------------

### Retrieve Thermostat Usage Data

Source: https://www.pelicanwireless.com/help-center/thermostatusage-attributes

This example demonstrates how to retrieve thermostat usage data using the Thermostat API. It requires specifying a start date, end date, and data aggregation interval. The API returns historical run-time and consumption information.

```OpenAPI
GET /thermostat/usage?startDateTime=2024-01-01T00:00:00Z&endDateTime=2024-01-31T23:59:59Z&duration=day
```

--------------------------------

### Network Communication Example

Source: https://www.pelicanwireless.com/help-center/how-can-i-replace-a-thermostat

This code illustrates how to establish network communication and send/receive data between clients and servers. It includes examples for socket programming.

```python
import socket

# Server configuration
HOST = '127.0.0.1'
PORT = 65432

with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
    s.bind((HOST, PORT))
    s.listen()
    conn, addr = s.accept()
    with conn:
        print(f'Connected by {addr}')
        data = conn.recv(1024)
        print(f'Received: {data.decode()}')
        conn.sendall(b'Hello from server!')
```

```python
import socket

# Client configuration
HOST = '127.0.0.1'
PORT = 65432

with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
    s.connect((HOST, PORT))
    s.sendall(b'Hello from client!')
    data = s.recv(1024)

print(f'Received: {data.decode()}')
```

--------------------------------

### OpenAPI Documentation for Pelican Wireless

Source: https://www.pelicanwireless.com/help-center/how-do-i-add-an-additional-gateway-to-my-existing-site

This section likely contains information or links to OpenAPI documentation for Pelican Wireless products and services. OpenAPI specifications allow developers to understand and interact with APIs programmatically.

```OpenAPI
## OpenAPI
  * OpenAPI
```

--------------------------------

### OpenAPI Documentation for Pelican Wireless

Source: https://www.pelicanwireless.com/help-center/how-do-i-create-a-new-pelican-site

This section likely contains information or links to OpenAPI documentation for Pelican Wireless products and services. OpenAPI specifications allow developers to understand and interact with APIs programmatically.

```OpenAPI
## OpenAPI
  * OpenAPI
```

--------------------------------

### GET Thermostat Events (Python)

Source: https://www.pelicanwireless.com/help-center/thermostatevent-attributes

Retrieves thermostat event information using Python's requests library. It sends a GET request to the API endpoint with authentication and selection parameters.

```python
import requests

url = "https://your-site-name.officeclimatecontrol.net/api.cgi?username=USERNAME&password=PASSWORD&request=get&object=ThermostatEvent&selection=name:Lobby;origin:all&value=eventId;title;startTime;endTime"
try:
    response = requests.get(url, verify=True)
    if response.status_code == 200:
        print("Success:", response.text)
    else:
        print("Error: HTTP", response.status_code)
except requests.exceptions.SSLError as e:
    print("SSL Error:", str(e))
except requests.exceptions.RequestException as e:
    print("Request Error:", str(e))

```

--------------------------------

### Get Thermostat Usage (Node.js)

Source: https://www.pelicanwireless.com/help-center/thermostatusage-attributes

Retrieves thermostat usage data using Node.js's https module. It makes an HTTPS GET request and logs the response data or any errors encountered.

```javascript
const https = require('https');

const url = 'https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=thermostatUsage&selection=startDateTime:2025-05-19T00:00;endDateTime:2025-05-19T23:59;duration:15minute;&value=name;heatMinutes;coolMinutes;fanMinutes;timestamp';

https.get(url, (resp) => {
  let data = '';

  // Collect data chunks
  resp.on('data', (chunk) => {
    data += chunk;
  });

  // Handle the complete response
  resp.on('end', () => {
    if (resp.statusCode === 200) {
      console.log('Success:', data);
    } else {
      console.log('Error: HTTP', resp.statusCode);
    }
  });
}).on('error', (err) => {
  console.error('Error:', err.message);
});

```

--------------------------------

### OpenAPI Documentation for Pelican Wireless

Source: https://www.pelicanwireless.com/help-center/how-do-i-navigate-the-main-page

This section likely contains information or links to OpenAPI documentation for Pelican Wireless products and services. OpenAPI specifications allow developers to understand and interact with APIs programmatically.

```OpenAPI
## OpenAPI
  * OpenAPI
```

--------------------------------

### GET Thermostat Events (Node.js)

Source: https://www.pelicanwireless.com/help-center/thermostatevent-attributes

Fetches thermostat event data using Node.js's https module. It makes a GET request to the API, handling data chunks and response status codes.

```javascript
const https = require('https');

const url = 'https://your-site-name.officeclimatecontrol.net/api.cgi?username=USERNAME&password=PASSWORD&request=get&object=ThermostatEvent&selection=name:Lobby;origin:all&value=eventId;title;startTime;endTime';

https.get(url, (resp) => {
  let data = '';

  // Collect data chunks
  resp.on('data', (chunk) => {
    data += chunk;
  });

  // Handle the complete response
  resp.on('end', () => {
    if (resp.statusCode === 200) {
      console.log('Success:', data);
    } else {
      console.log('Error: HTTP', resp.statusCode);
    }
  });
}).on('error', (err) => {
  console.error('Error:', err.message);
});

```
Tokens:
Raw