Table of Contents

Class GoAnywhere

Namespace
Geotab.Checkmate.ObjectModel
Assembly
Geotab.Checkmate.ObjectModel.dll

The GO Anywhere device. Additional properties can be seen in XDevice.

public class GoAnywhere : XDevice, IEntity, IComparable, IIdentifiable, IVersion, IGroupLinked, ITimeZoneIdProvider, IDefaultable, ICustomizable<Device>, IMediaFiles, IInstanceSizeEstimate, IVehicleIdentificationNumber, ILicensable, IAutoGroupsProvider, IGoAnywhereDevice
Inheritance
GoAnywhere
Implements
Inherited Members

Constructors

GoAnywhere()

Initializes a new instance of the GoAnywhere class.

public GoAnywhere()

GoAnywhere(Id?, long?, string?, string?, string?, string?, bool?, string?, string?, int?, TimeSpan?, DateTime?, int?, string?, bool?, short?, short?, WorkTime?, float?, IList<Group>?, string?, DeviceFlags?, IList<Group>?, List<CustomParameter>?, int?, uint?, bool?, DateTime?, DateTime?, IReadOnlyList<DevicePlanBillingInfo>?, uint?, List<PropertyValue<Device>>?, int?, bool?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, int?, bool?, bool?, bool?, bool?, bool?, bool?, bool?, bool?, bool?, uint?, bool?, uint?, uint[]?, EosAssetMovementType, uint?)

Initializes a new instance of the GoAnywhere class.

public GoAnywhere(Id? id, long? version, string? name, string? comment, string? vehicleIdentificationNumber, string? engineVehicleIdentificationNumber, bool? pinDevice, string? licensePlate, string? licenseState, int? productId, TimeSpan? timeToDownload, DateTime? ignoreDownloadsUntil, int? hardwareId, string? serialNumber, bool? enableMustReprogram, short? minor, short? major, WorkTime? workTime, float? maxSecondsBetweenLogs, IList<Group>? groups, string? timeZoneId, DeviceFlags? deviceFlags, IList<Group>? autoGroups, List<CustomParameter>? customParameters, int? gpsOffDelay, uint? parameterVersion, bool? ensureHotStart, DateTime? activeTo, DateTime? activeFrom, IReadOnlyList<DevicePlanBillingInfo>? devicePlanBillingInfo, uint? parameterVersionOnDevice, List<PropertyValue<Device>>? customProperties, int? communicationFrequency, bool? assetRecoveryModeEnabled, int? bistStartupDelay, int? minBatteryVoltage, int? maxTemperature, int? shippingNetworkTimeout, int? shippingGwTimeout, int? shippingHealthCheckInterval, int? shippingCommunicationInterval, int? sleepCommunicationInterval, int? sleepHealthCheckInterval, int? sleepHealthCheckIntervalReduced, int? sleepNetworkTimeout, int? sleepGwTimeout, int? movementHealthCheckInterval, int? gnssFixInterval, int? gnssFixCount, int? gnssMinDistance, int? speedThreshold, int? speedDuration, int? accelerationThreshold, int? speedDetectionMin, int? communicationRetryMax, int? modemMaxConnectionTime, int? gsmRssiMin, int? gsmSinrMin, int? lteRssiMin, int? lteSinrMin, int? modemMinVoltage, int? movementDetectionDistanceThreshold, bool? accelerometerDisabled, bool? voltageLoggingDisabled, bool? gnssLoggingDisabled, bool? gnssAidingDataDisabled, bool? deviceFotaDisabled, bool? enableModemFota, bool? checkInOnTripEnabled, bool? checkInOnTripEndEnabled, bool? scheduledSyncEnabled, uint? scheduledSyncTime, bool? timedCheckInEnabled, uint? timedCheckInEntries, uint[]? timedCheckInSeconds, EosAssetMovementType assetMovementType, uint? expectedParameterVersionOnDeviceToSyncRecovery)

Parameters

id Id

The ID.

version long?

The version.

name string

The name.

comment string

The comment.

vehicleIdentificationNumber string

The VIN.

engineVehicleIdentificationNumber string

The engine reported VIN.

pinDevice bool?

When enabled vehicles are not automatically managed when the device is moved from vehicle to vehicle.

licensePlate string

The licence plate.

licenseState string

The licence state.

productId int?

The product ID.

timeToDownload TimeSpan?

The time to download.

ignoreDownloadsUntil DateTime?

Ignore downloads unit this time.

hardwareId int?

The hardware ID.

serialNumber string

The serial number of the device.

enableMustReprogram bool?

Enable must reprogram.

minor short?

The minor version.

major short?

The major version.

workTime WorkTime

The work time.

maxSecondsBetweenLogs float?

The max number of seconds between receiving logs from the device. If exceeded, data is considered missing. Must be at least 200s.

groups IList<Group>

The groups.

timeZoneId string

The Timezone ID.

deviceFlags DeviceFlags

Device flags.

autoGroups IList<Group>

The auto groups.

customParameters List<CustomParameter>

The custom parameters.

gpsOffDelay int?

The GPS off delay.

parameterVersion uint?

The parameter version.

ensureHotStart bool?

Enable hot start.

activeTo DateTime?

Date after which device becomes [Archived].

activeFrom DateTime?

Date after which device becomes active.

devicePlanBillingInfo IReadOnlyList<DevicePlanBillingInfo>

The device plan billing information.

parameterVersionOnDevice uint?

The parameter version that is currently stored on the Device.

customProperties List<PropertyValue<Device>>

The custom properties and its associated PropertyValue<T>s for this device.

communicationFrequency int?

Communication Rate of the Go Anywhere device

assetRecoveryModeEnabled bool?

Asset recovery mode of the Go Anywhere device

bistStartupDelay int?

The Built In Self Test startup delay.

minBatteryVoltage int?

The Shipping minimum battery voltage.

maxTemperature int?

The Shipping maximum temperature.

shippingNetworkTimeout int?

The Shipping network registration timeout.

shippingGwTimeout int?

The Shipping gateway connection timeout.

shippingHealthCheckInterval int?

The Shipping Health check interval.

shippingCommunicationInterval int?

The Shipping Communication interval.

sleepCommunicationInterval int?

The Sleep communication interval.

sleepHealthCheckInterval int?

The Sleep health check interval.

sleepHealthCheckIntervalReduced int?

The Sleep health check interval if alarm is active.

sleepNetworkTimeout int?

The Sleep Network registration timeout.

sleepGwTimeout int?

The Sleep gateway connection timeout.

movementHealthCheckInterval int?

The Movement health check interval.

gnssFixInterval int?

The Movement GNSS fix interval.

gnssFixCount int?

The Number of GNSS fixes to confirm movement.

gnssMinDistance int?

The Minimum distance traveled to confirm movement.

speedThreshold int?

The GNSS reported speed in used to confirm movement.

speedDuration int?

The Number of speed samples to determine speed average.

accelerationThreshold int?

The Accelerometer threshold.

speedDetectionMin int?

Accelerometer sustained speed minimum for impact detection.

communicationRetryMax int?

Maximum number of communication retries.

modemMaxConnectionTime int?

Maximum modem connection time.

gsmRssiMin int?

Modem GSM Received Signal Strength Indicator.

gsmSinrMin int?

Modem GSM Signal to Interference &amp.

lteRssiMin int?

Modem LTE Received Signal Strength Indicator.

lteSinrMin int?

Modem LTE Signal to Interference &amp.

modemMinVoltage int?

Minimum battery voltage required to allow modem communication.

movementDetectionDistanceThreshold int?

The movement detection distance threshold.

accelerometerDisabled bool?

The value for Disable accelerometer.

voltageLoggingDisabled bool?

The value for Disable battery voltage logging.

gnssLoggingDisabled bool?

The value for Disable GNSS logging.

gnssAidingDataDisabled bool?

The value for Disable GNSS aiding data.

deviceFotaDisabled bool?

The value for Disable FOTA updates.

enableModemFota bool?

The value for Enable modem FOTA updates.

checkInOnTripEnabled bool?

value for indicating if the Go Anywhere device movement alert or trip start alert is enabled

checkInOnTripEndEnabled bool?

value for indicating if the Go Anywhere device trip end alert is enabled

scheduledSyncEnabled bool?

value for indicating if the Go Anywhere device scheduled sync is enabled

scheduledSyncTime uint?

value for the Go Anywhere device scheduled sync time, it's the number of seconds since midnight 00:00 UTC

timedCheckInEnabled bool?

value for indicating if the Go Anywhere device timed check-in is enabled

timedCheckInEntries uint?

value for the number of the Go Anywhere device timed check-ins

timedCheckInSeconds uint[]

value for the array of the Go Anywhere device check-in times in seconds

assetMovementType EosAssetMovementType

value of the Go Anywhere device type

expectedParameterVersionOnDeviceToSyncRecovery uint?

This is the expected ParameterVersionOnDevice value when the asset recovery setting will be in sync with the device.

Properties

AccelerationThreshold

Gets or sets value for the Accelerometer threshold, in mg. Default [2000].

[ProtobufDeviceParameter]
public int? AccelerationThreshold { get; set; }

Property Value

int?

int

Remarks

Acceleration or deceleration greater than this threshold lasting 10ms or more is considered an impact event

AccelerometerDisabled

Gets or sets the value for Disable accelerometer. Default [false].

public bool? AccelerometerDisabled { get; set; }

Property Value

bool?

bool

AssetMovementType

Gets or sets value of the Go Anywhere device type.

[Obsolete("AssetMovementType is obsolete and will be removed. Do not use.", false)]
public EosAssetMovementType? AssetMovementType { get; set; }

Property Value

EosAssetMovementType?

EosAssetMovementType

AssetRecoveryModeEnabled

Gets or sets value for indicating if the Go Anywhere device asset recovery mode is enabled. Default [false].

[ProtobufDeviceParameter]
public bool? AssetRecoveryModeEnabled { get; set; }

Property Value

bool?

bool

BistStartupDelay

Gets or sets value for the Built In Self Test startup delay in seconds. Default [60].

[ProtobufDeviceParameter]
public int? BistStartupDelay { get; set; }

Property Value

int?

int

CheckInOnTripEnabled

Gets or sets value for indicating if the Go Anywhere device movement alert or trip start alert is enabled. Default [false].

[ProtobufDeviceParameter]
public bool? CheckInOnTripEnabled { get; set; }

Property Value

bool?

bool

CheckInOnTripEndEnabled

Gets or sets value for indicating if the Go Anywhere device trip end alert is enabled. Default [false].

[ProtobufDeviceParameter]
public bool? CheckInOnTripEndEnabled { get; set; }

Property Value

bool?

bool

CommunicationFrequency

Gets or sets value for the Go Anywhere device communication rate in minutes. Default [1440].

[ProtobufDeviceParameter]
public int? CommunicationFrequency { get; set; }

Property Value

int?

int

CommunicationRetryMax

Gets or sets Maximum number of communication retries. Default [5].

[ProtobufDeviceParameter]
public int? CommunicationRetryMax { get; set; }

Property Value

int?

int

DeviceFotaDisabled

Gets or sets the value for Disable FOTA updates. Default [false].

public bool? DeviceFotaDisabled { get; set; }

Property Value

bool?

bool

EnableModemFota

Gets or sets the value for Enable modem FOTA updates. Default [true].

public bool? EnableModemFota { get; set; }

Property Value

bool?

bool

ExpectedParameterVersionOnDeviceToSyncRecovery

Gets or sets the value for asset recovery setting version value. The value is expected ParameterVersionOnDevice value when the asset recovery setting will be in sync with the device.

public uint? ExpectedParameterVersionOnDeviceToSyncRecovery { get; set; }

Property Value

uint?

uint

GnssAidingDataDisabled

Gets or sets the value for Disable GNSS aiding data. Default [false].

public bool? GnssAidingDataDisabled { get; set; }

Property Value

bool?

bool

GnssFixCount

Gets or sets value for the Number of GNSS fixes to confirm movement. Default [2].

[ProtobufDeviceParameter]
public int? GnssFixCount { get; set; }

Property Value

int?

int

GnssFixInterval

Gets or sets value for the Movement GNSS fix interval in seconds. Default [900].

[ProtobufDeviceParameter]
public int? GnssFixInterval { get; set; }

Property Value

int?

int

GnssLoggingDisabled

Gets or sets the value for Disable GNSS logging. Default [false].

public bool? GnssLoggingDisabled { get; set; }

Property Value

bool?

bool

GnssMinDistance

Gets or sets value for the Minimum distance traveled to confirm movement, in meters. Default [200].

[ProtobufDeviceParameter]
public int? GnssMinDistance { get; set; }

Property Value

int?

int

GsmRssiMin

Gets or sets Modem GSM Received Signal Strength Indicator (127 = disabled). Default [-90].

[ProtobufDeviceParameter]
public int? GsmRssiMin { get; set; }

Property Value

int?

int

GsmSinrMin

Gets or sets Modem GSM Signal to Interference & Noise Ratio (127 = disabled). Default [127].

[ProtobufDeviceParameter]
public int? GsmSinrMin { get; set; }

Property Value

int?

int

LteRssiMin

Gets or sets Modem LTE Received Signal Strength Indicator (127 = disabled). Default [-95].

[ProtobufDeviceParameter]
public int? LteRssiMin { get; set; }

Property Value

int?

int

LteSinrMin

Gets or sets Modem LTE Signal to Interference & Noise Ratio (127 = disabled). Default [127].

[ProtobufDeviceParameter]
public int? LteSinrMin { get; set; }

Property Value

int?

int

MaxTemperature

Gets or sets value for the Shipping maximum temperature in degree Celsius. Default [80].

[ProtobufDeviceParameter]
public int? MaxTemperature { get; set; }

Property Value

int?

int

MinBatteryVoltage

Gets or sets value for the Shipping minimum battery voltage in milli-volts. Default [4000].

[ProtobufDeviceParameter]
public int? MinBatteryVoltage { get; set; }

Property Value

int?

int

ModemMaxConnectionTime

Gets or sets maximum modem connection time in seconds. Default [300].

[ProtobufDeviceParameter]
public int? ModemMaxConnectionTime { get; set; }

Property Value

int?

int

ModemMinVoltage

Gets or sets Minimum battery voltage required to allow modem communication, in milli-volts. Default [4000].

[ProtobufDeviceParameter]
public int? ModemMinVoltage { get; set; }

Property Value

int?

int

MovementDetectionDistanceThreshold

Gets or sets movement detection distance, in cm. Default [70].

[ProtobufDeviceParameter]
public int? MovementDetectionDistanceThreshold { get; set; }

Property Value

int?

int

MovementHealthCheckInterval

Gets or sets value for the Movement health check interval in seconds. Default [86400].

[ProtobufDeviceParameter]
public int? MovementHealthCheckInterval { get; set; }

Property Value

int?

int

ScheduledSyncEnabled

Gets or sets value for indicating if the Go Anywhere device scheduled sync is enabled. Default [false].

[ProtobufDeviceParameter]
public bool? ScheduledSyncEnabled { get; set; }

Property Value

bool?

bool

ScheduledSyncTime

Gets or sets value for the Go Anywhere device scheduled sync time, it's the number of seconds since midnight 00:00 UTC. Default [0].

[ProtobufDeviceParameter]
public uint? ScheduledSyncTime { get; set; }

Property Value

uint?

uint

ShippingCommunicationInterval

Gets or sets value for the Shipping Communication interval in seconds (-1 is never). Default [-1].

[ProtobufDeviceParameter]
public int? ShippingCommunicationInterval { get; set; }

Property Value

int?

int

ShippingGwTimeout

Gets or sets value for the Shipping gateway connection timeout in seconds. Default [60].

[ProtobufDeviceParameter]
public int? ShippingGwTimeout { get; set; }

Property Value

int?

int

ShippingHealthCheckInterval

Gets or sets value for the Shipping Health check interval in seconds (-1 is never). Default [-1].

[ProtobufDeviceParameter]
public int? ShippingHealthCheckInterval { get; set; }

Property Value

int?

int

ShippingNetworkTimeout

Gets or sets value for the Shipping network registration timeout value in seconds. Default [120].

[ProtobufDeviceParameter]
public int? ShippingNetworkTimeout { get; set; }

Property Value

int?

int

SleepCommunicationInterval

Gets or sets value for the Sleep communication interval in seconds. Default [259200].

[ProtobufDeviceParameter]
public int? SleepCommunicationInterval { get; set; }

Property Value

int?

int

SleepGwTimeout

Gets or sets value for the Sleep gateway connection timeout in seconds. Default [60].

[ProtobufDeviceParameter]
public int? SleepGwTimeout { get; set; }

Property Value

int?

int

SleepHealthCheckInterval

Gets or sets value for the Sleep health check interval in seconds. Default [259200].

[ProtobufDeviceParameter]
public int? SleepHealthCheckInterval { get; set; }

Property Value

int?

int

SleepHealthCheckIntervalReduced

Gets or sets value for the Sleep health check interval in seconds if alarm is active. Default [86400].

[ProtobufDeviceParameter]
public int? SleepHealthCheckIntervalReduced { get; set; }

Property Value

int?

int

SleepNetworkTimeout

Gets or sets value for the Sleep Network registration timeout value in seconds. Default [120].

[ProtobufDeviceParameter]
public int? SleepNetworkTimeout { get; set; }

Property Value

int?

int

SpeedDetectionMin

Gets or sets Accelerometer sustained speed minimum for impact detection, in m/s. Default [0].

[ProtobufDeviceParameter]
public int? SpeedDetectionMin { get; set; }

Property Value

int?

int

SpeedDuration

Gets or sets value for the Number of speed samples to determine speed average, in seconds. Default [5].

[ProtobufDeviceParameter]
public int? SpeedDuration { get; set; }

Property Value

int?

int

SpeedThreshold

Gets or sets GNSS reported speed in m/s used to confirm movement, start of trip. Default [4].

[ProtobufDeviceParameter]
public int? SpeedThreshold { get; set; }

Property Value

int?

int

TimedCheckInEnabled

Gets or sets value for indicating if the Go Anywhere device timed check-in is enabled. Default [false].

[ProtobufDeviceParameter]
public bool? TimedCheckInEnabled { get; set; }

Property Value

bool?

bool

TimedCheckInEntries

Gets or sets value for the number of the Go Anywhere device timed check-ins. Default [0].

[ProtobufDeviceParameter]
public uint? TimedCheckInEntries { get; set; }

Property Value

uint?

uint

TimedCheckInSeconds

Gets or sets value for the array of the Go Anywhere device check-in times in seconds.

[ProtobufDeviceParameter]
public uint[]? TimedCheckInSeconds { get; set; }

Property Value

uint[]

an array of uint.

VoltageLoggingDisabled

Gets or sets the value for Disable battery voltage logging. Default [false].

public bool? VoltageLoggingDisabled { get; set; }

Property Value

bool?

bool

Methods

Clone()

Creates a new object that is a copy of the current instance.

public override IEntity Clone()

Returns

IEntity

A new object that is a copy of this instance.

PopulateDefaults()

Populate non-required empty (null) properties with default values.

public override void PopulateDefaults()