fetch_ats_transmissions: Download Transmission Data from ATS Website
In Huh/collar: Utilities for Accessing and Manipulating GPS Data

fetch_ats_transmissions

R Documentation

Download Transmission Data from ATS Website

Description

Retrieves all transmissions or undownloaded transmissions, optionally filtered by collar

Usage

fetch_ats_transmissions(device_id = NULL, new = FALSE, chunk_size = 50L)

Arguments

`device_id`	A single device id, or a list or vector of device ids, or NULL for all devices associated with current account. Overrides the new parameter when specified. If the device ids returned by `fetch_ats_devices` have leading zeros they should be included in the `device_id` parameter as well (e.g. `device_id = "012345")`).
`new`	Currently ignored due to changes in the ATS website.
`chunk_size`	A single integer (default = 50) specifying how many collars are downloaded per HTTP request. In some rare cases entire batches may fail (with a warning) due to a few problematic collars, in which case you should set chunk_size to 1 to ensure that all available data is retrieved.

Value

A tibble with 20 columns:

CollarSerialNumber: ATS Collar ID (character)
DateCT: Timestamp from server (US Cental time, POSIXct))
DateUTC: Timestamp in UTC/GMT (POSIXct)
DateLocal: Timestamp in current system time zone (POSIXct)
NumberFixes: Number of fixes transmitted (integer)
BattVoltage: Battery voltage (numeric)
Mortality: Mortality message (character)
BreakOff: Breakoff message (character)
GpsOnTime: GPS module on time (integer)
SatOnTime: Satellite module on time (integer)
SatErrors: Number of satellite errors (integer)
GmtOffset: Offset (in hours) from UTC/GMT (numeric)
LowBatt: Is collar in low battery mode (logical)
Birth: VIT birth event (character)
Fawn0: Neolink slot 0 event (character)
Fawn1: Neolink slot 1 event (character)
Fawn2: Neolink slot 2 event (character)
Latitude: Latitude in decimal degrees (numeric)
Longitude: Latitude in decimal degrees (numeric)
CEPradius_km: Circular Error Probability in km (integer)

Examples

## Not run: 

ats_login("mary", ".")

# get all transmissions for all collars in this account
trans <- fetch_ats_transmissions()

# get all transmissions for specific collars
collar_list <- sample(fetch_ats_devices(), 10)
trans <- fetch_ats_transmissions(device_id = collar_list)

# set chunk_size to 1 to ensure you get all available data
#   if you're experiencing issues, but the download will
#   take much longer to complete.
trans <- fetch_ats_transmissions(chunk_size = 1)

ats_logout()


## End(Not run)

Huh/collar documentation built on Jan. 19, 2025, 1:15 a.m.