Device (java-sdk 9.0.1 API)

java.lang.Object
- com.geotab.model.entity.Entity
- - com.geotab.model.entity.NameEntity
  - - com.geotab.model.entity.NameEntityWithVersion
    - - com.geotab.model.entity.device.Device

Direct Known Subclasses:

CustomDevice, GoDevice, GoDriveDevice, NoDevice, UntrackedAsset
```
public class Device
extends NameEntityWithVersion
```
A Device represents the physical tracking device installed in the vehicle. A device and vehicle is typically synonymous since the GO tracking device is installed in a vehicle. In the case where there is no device; this is represented by "NoDeviceId".

Nested Class Summary
- Nested classes/interfaces inherited from class com.geotab.model.entity.Entity
  Entity.EntityBuilder<C extends Entity,B extends Entity.EntityBuilder<C,B>>

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`A1_PREFIX` The default serial number prefix for aptiv A1 devices.
`static int`	`A1_PRODUCT_ID` The default Product ID for A1 devices.
`protected LocalDateTime`	`activeFrom` The date the device is active from.
`protected LocalDateTime`	`activeTo` The date that the device is active to.
`protected String`	`comment` Free text field where any user information can be stored and referenced for this entity.
`static int`	`CUSTOM_DEVICE_PRODUCT_ID` The default product Id for third-party devices.
`protected Map<String,Object>`	`customFeatures` The custom features for this device and their values.
`protected List<PropertyValue>`	`customProperties` The set of dynamic, user created, custom properties.
`static Float`	`DEFAULT_MAX_NO_LOG_SECONDS`
`protected DeviceFlags`	`deviceFlags` The device features which have been enabled whether the feature is in use (e.g.
`protected List<DevicePlanBillingInfo>`	`devicePlanBillingInfo` The `DevicePlanBillingInfo` that has been purchased for this device.
`protected List<DevicePlan>`	`devicePlans` Geotab DevicePlan that has been purchased for this device.
`protected DeviceType`	`deviceType` Specifies the GO or Custom `DeviceType`.
`static String`	`GO_DRIVE_PREFIX` The default serial number prefix for GoDrive mobile devices.
`static int`	`GO_DRIVE_PRODUCT_ID` The default product Id for GoDrive mobile devices.
`static int`	`GO_MAX_PRODUCT_ID` The maximum Product ID for Go devices.
`static Map<String,Integer>`	`GO_PREFIX_TO_PRODUCT_ID_MAPPING` Prefix to product id mapping.
`static String`	`GO10_PREFIX` The default serial number prefix for Go10 devices.
`static int`	`GO10_PRODUCT_ID` The default Product ID for Go9 devices.
`static String`	`GO2_PREFIX` The default serial number prefix for Go2 devices.
`static int`	`GO2_PRODUCT_ID` The default product Id for Go2 devices.
`static String`	`GO3_PREFIX` The default serial number prefix for Go3 devices.
`static int`	`GO3_PRODUCT_ID` The default product Id for Go3 devices.
`static String`	`GO4_PREFIX` The default serial number prefix for Go4 devices (pre Go4v3).
`static int`	`GO4_PRODUCT_ID` The default product Id for Go4 devices (pre Go4v3).
`static String`	`GO4_V3_PREFIX` The default serial number prefix for Go4v3 devices.
`static int`	`GO4_V3_PRODUCT_ID` The default product Id for Go4v3 devices.
`static String`	`GO5_PREFIX` The default serial number prefix for Go5 devices.
`static int`	`GO5_PRODUCT_ID` The default product Id for Go5 devices.
`static String`	`GO6_PREFIX` The default serial number prefix for Go6 devices.
`static int`	`GO6_PRODUCT_ID` The default Product ID for Go6 devices.
`static String`	`GO7_PREFIX` The default serial number prefix for Go7 devices.
`static int`	`GO7_PRODUCT_ID` The default Product ID for Go7 devices.
`static String`	`GO8_PREFIX` The default serial number prefix for Go8 devices.
`static int`	`GO8_PRODUCT_ID` The default Product ID for Go8 devices.
`static int`	`GO8_PRODUCT_ID_NO_GPS` The default Product ID for Go8 devices without a gps.
`static String`	`GO9_PREFIX` The default serial number prefix for Go9 devices.
`static int`	`GO9_PRODUCT_ID` The default Product ID for Go9 devices.
`static int`	`GO9_PRODUCT_ID_NO_GPS` The default Product ID for Go9 devices without a gps.
`static String`	`GO9B_PREFIX` The default serial number prefix for Go9 devices.
`static int`	`GO9B_PRODUCT_ID` The default Product ID for Go9b devices.
`protected List<Group>`	`groups` The list of `Group`(s) the device belongs to.
`static int`	`HISTORIC_MAX` The maximum id value for devices that are archived.
`static int`	`HISTORIC_MIN` The minimum id value for devices that are archived.
`static String`	`HISTORIC_SERIAL_NUMBER` The default serial number of historic devices.
`protected LocalDateTime`	`ignoreDownloadsUntil` The date that tells the system at what moment should it start checking the device status and warn if there is no new data.
`static LocalDateTime`	`MAX_DATE`
`protected Float`	`maxSecondsBetweenLogs` The maximum allowed time between logs when the ignition is on in seconds.
`protected List<MediaFile>`	`mediaFiles` The list of `MediaFile` for this asset.
`static LocalDateTime`	`MIN_DATE`
`protected Float`	`minSecondsBetweenLogs` The minimum allowable value for maxSecondsBetweenLogs.
`static int`	`OLD_GEOTAB_PRODUCT_ID`
`protected Integer`	`productId` The product id.
`protected String`	`serialNumber` The Serial Number of the device.
`protected Duration`	`timeToDownload` Gets or sets the expected time between downloads, i.e.
`protected String`	`timeZoneId` The IANA time zone Id of the device used to determine local work times.
`static String`	`U1_PREFIX` The default serial number prefix for A1 devices.
`static int`	`U1_PRODUCT_ID` The default Product ID for U1 devices.
`static int`	`UNTRACKED_ASSET_HARDWARE_ID` The default Hardware Id for untracked assets.
`static int`	`UNTRACKED_ASSET_PRODUCT_ID` The default Product ID for untracked assets.
`protected WorkTime`	`workTime` The `WorkTime` rules to apply to the device.

Constructor Summary

Constructors
Constructor and Description

Device()

Constructors
Constructor and Description
`Device()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DeviceType`	`deviceTypeFromProductId(int productId)` Maps the given productId to a `DeviceType`.
`static Device`	`fromProductId(int productId)` Get the correct Device object from the given product Id.
`static Device`	`fromSerialNumber(String serialNumber)` Returns the correct type of device for the given serial number.
`boolean`	`isNoGpsDevice()` Determine if a device is NoGps Device by its productId.
`void`	`populateDefaults()` Set default values for the `Device` instance.
`static String`	`prefixFromDeviceType(int productId)` Returns the string prefix of the given product ID.
`static int`	`productIdFromSerialNumber(String serialNumber)` Returns the product id from its serial number.

Methods inherited from class com.geotab.model.entity.Entity
addExtraProperty, getExtraProperties, isSystemEntity

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_MAX_NO_LOG_SECONDS
```
public static final Float DEFAULT_MAX_NO_LOG_SECONDS
```
  - MAX_DATE
```
public static final LocalDateTime MAX_DATE
```
  - MIN_DATE
```
public static final LocalDateTime MIN_DATE
```
  - HISTORIC_SERIAL_NUMBER
```
public static final String HISTORIC_SERIAL_NUMBER
```
    The default serial number of historic devices.
    
    See Also:
    
    Constant Field Values
  - HISTORIC_MIN
```
public static final int HISTORIC_MIN
```
    The minimum id value for devices that are archived.
    
    See Also:
    
    Constant Field Values
  - HISTORIC_MAX
```
public static final int HISTORIC_MAX
```
    The maximum id value for devices that are archived.
    
    See Also:
    
    Constant Field Values
  - CUSTOM_DEVICE_PRODUCT_ID
```
public static final int CUSTOM_DEVICE_PRODUCT_ID
```
    The default product Id for third-party devices.
    
    See Also:
    
    Constant Field Values
  - GO_DRIVE_PRODUCT_ID
```
public static final int GO_DRIVE_PRODUCT_ID
```
    The default product Id for GoDrive mobile devices.
    
    See Also:
    
    Constant Field Values
  - GO_DRIVE_PREFIX
```
public static final String GO_DRIVE_PREFIX
```
    The default serial number prefix for GoDrive mobile devices.
    
    See Also:
    
    Constant Field Values
  - GO2_PRODUCT_ID
```
public static final int GO2_PRODUCT_ID
```
    The default product Id for Go2 devices.
    
    See Also:
    
    Constant Field Values
  - GO2_PREFIX
```
public static final String GO2_PREFIX
```
    The default serial number prefix for Go2 devices.
    
    See Also:
    
    Constant Field Values
  - GO3_PRODUCT_ID
```
public static final int GO3_PRODUCT_ID
```
    The default product Id for Go3 devices.
    
    See Also:
    
    Constant Field Values
  - GO3_PREFIX
```
public static final String GO3_PREFIX
```
    The default serial number prefix for Go3 devices.
    
    See Also:
    
    Constant Field Values
  - GO4_PRODUCT_ID
```
public static final int GO4_PRODUCT_ID
```
    The default product Id for Go4 devices (pre Go4v3).
    
    See Also:
    
    Constant Field Values
  - GO4_PREFIX
```
public static final String GO4_PREFIX
```
    The default serial number prefix for Go4 devices (pre Go4v3).
    
    See Also:
    
    Constant Field Values
  - GO4_V3_PRODUCT_ID
```
public static final int GO4_V3_PRODUCT_ID
```
    The default product Id for Go4v3 devices.
    
    See Also:
    
    Constant Field Values
  - GO4_V3_PREFIX
```
public static final String GO4_V3_PREFIX
```
    The default serial number prefix for Go4v3 devices.
    
    See Also:
    
    Constant Field Values
  - GO5_PRODUCT_ID
```
public static final int GO5_PRODUCT_ID
```
    The default product Id for Go5 devices.
    
    See Also:
    
    Constant Field Values
  - GO5_PREFIX
```
public static final String GO5_PREFIX
```
    The default serial number prefix for Go5 devices.
    
    See Also:
    
    Constant Field Values
  - GO6_PRODUCT_ID
```
public static final int GO6_PRODUCT_ID
```
    The default Product ID for Go6 devices.
    
    See Also:
    
    Constant Field Values
  - GO6_PREFIX
```
public static final String GO6_PREFIX
```
    The default serial number prefix for Go6 devices.
    
    See Also:
    
    Constant Field Values
  - GO7_PRODUCT_ID
```
public static final int GO7_PRODUCT_ID
```
    The default Product ID for Go7 devices.
    
    See Also:
    
    Constant Field Values
  - GO7_PREFIX
```
public static final String GO7_PREFIX
```
    The default serial number prefix for Go7 devices.
    
    See Also:
    
    Constant Field Values
  - GO8_PRODUCT_ID
```
public static final int GO8_PRODUCT_ID
```
    The default Product ID for Go8 devices.
    
    See Also:
    
    Constant Field Values
  - GO8_PREFIX
```
public static final String GO8_PREFIX
```
    The default serial number prefix for Go8 devices.
    
    See Also:
    
    Constant Field Values
  - GO8_PRODUCT_ID_NO_GPS
```
public static final int GO8_PRODUCT_ID_NO_GPS
```
    The default Product ID for Go8 devices without a gps.
    
    See Also:
    
    Constant Field Values
  - GO9_PRODUCT_ID
```
public static final int GO9_PRODUCT_ID
```
    The default Product ID for Go9 devices.
    
    See Also:
    
    Constant Field Values
  - GO9_PREFIX
```
public static final String GO9_PREFIX
```
    The default serial number prefix for Go9 devices.
    
    See Also:
    
    Constant Field Values
  - GO9B_PRODUCT_ID
```
public static final int GO9B_PRODUCT_ID
```
    The default Product ID for Go9b devices.
    
    See Also:
    
    Constant Field Values
  - GO9B_PREFIX
```
public static final String GO9B_PREFIX
```
    The default serial number prefix for Go9 devices.
    
    See Also:
    
    Constant Field Values
  - GO10_PRODUCT_ID
```
public static final int GO10_PRODUCT_ID
```
    The default Product ID for Go9 devices.
    
    See Also:
    
    Constant Field Values
  - GO10_PREFIX
```
public static final String GO10_PREFIX
```
    The default serial number prefix for Go10 devices.
    
    See Also:
    
    Constant Field Values
  - A1_PREFIX
```
public static final String A1_PREFIX
```
    The default serial number prefix for aptiv A1 devices.
    
    See Also:
    
    Constant Field Values
  - A1_PRODUCT_ID
```
public static final int A1_PRODUCT_ID
```
    The default Product ID for A1 devices.
    
    See Also:
    
    Constant Field Values
  - U1_PREFIX
```
public static final String U1_PREFIX
```
    The default serial number prefix for A1 devices.
    
    See Also:
    
    Constant Field Values
  - U1_PRODUCT_ID
```
public static final int U1_PRODUCT_ID
```
    The default Product ID for U1 devices.
    
    See Also:
    
    Constant Field Values
  - GO9_PRODUCT_ID_NO_GPS
```
public static final int GO9_PRODUCT_ID_NO_GPS
```
    The default Product ID for Go9 devices without a gps.
    
    See Also:
    
    Constant Field Values
  - GO_MAX_PRODUCT_ID
```
public static final int GO_MAX_PRODUCT_ID
```
    The maximum Product ID for Go devices.
    
    See Also:
    
    Constant Field Values
  - UNTRACKED_ASSET_PRODUCT_ID
```
public static final int UNTRACKED_ASSET_PRODUCT_ID
```
    The default Product ID for untracked assets.
    
    See Also:
    
    Constant Field Values
  - UNTRACKED_ASSET_HARDWARE_ID
```
public static final int UNTRACKED_ASSET_HARDWARE_ID
```
    The default Hardware Id for untracked assets.
    
    See Also:
    
    Constant Field Values
  - OLD_GEOTAB_PRODUCT_ID
```
public static final int OLD_GEOTAB_PRODUCT_ID
```
    See Also:
    
    Constant Field Values
  - GO_PREFIX_TO_PRODUCT_ID_MAPPING
```
public static final Map<String,Integer> GO_PREFIX_TO_PRODUCT_ID_MAPPING
```
    Prefix to product id mapping.
  - deviceType
```
protected DeviceType deviceType
```
    Specifies the GO or Custom DeviceType.
  - productId
```
protected Integer productId
```
    The product id. Each device is assigned a unique hardware product id.
  - serialNumber
```
protected String serialNumber
```
    The Serial Number of the device. Maximum length [12].
  - ignoreDownloadsUntil
```
protected LocalDateTime ignoreDownloadsUntil
```
    The date that tells the system at what moment should it start checking the device status and warn if there is no new data. Used when a new device is just installed or the vehicle undergoes a lengthy service. Default [MinDate].
  - timeToDownload
```
protected Duration timeToDownload
```
    Gets or sets the expected time between downloads, i.e. how frequently the device is expected to produce new data. For passive devices this might range from 1 to a few days. For live devices this should be maximum 24h unless vehicles travel out of coverage frequently. This is used to check if the device is in good state.
  - workTime
```
protected WorkTime workTime
```
    The WorkTime rules to apply to the device. Default [WorkTimeStandardHours].
  - groups
```
protected List<Group> groups
```
    The list of Group(s) the device belongs to.
  - devicePlans
```
protected List<DevicePlan> devicePlans
```
    Geotab DevicePlan that has been purchased for this device.
  - devicePlanBillingInfo
```
protected List<DevicePlanBillingInfo> devicePlanBillingInfo
```
    The DevicePlanBillingInfo that has been purchased for this device.
  - timeZoneId
```
protected String timeZoneId
```
    The IANA time zone Id of the device used to determine local work times. This is typically the "home location" of the device. Default ["America/New_York"].
  - minSecondsBetweenLogs
```
protected Float minSecondsBetweenLogs
```
    The minimum allowable value for maxSecondsBetweenLogs. Defaults to 0.0f.
  - maxSecondsBetweenLogs
```
protected Float maxSecondsBetweenLogs
```
    The maximum allowed time between logs when the ignition is on in seconds. When the value is exceeded, data is considered to be missing. Default [200].
  - activeFrom
```
protected LocalDateTime activeFrom
```
    The date the device is active from. Default [MIN_DATE].
  - activeTo
```
protected LocalDateTime activeTo
```
    The date that the device is active to. Default [MAX_DATE].
  - comment
```
protected String comment
```
    Free text field where any user information can be stored and referenced for this entity.
  - deviceFlags
```
protected DeviceFlags deviceFlags
```
    The device features which have been enabled whether the feature is in use (e.g. HOS, Iridium). The DevicePlan property cannot be added/updated via the API.
  - customFeatures
```
protected Map<String,Object> customFeatures
```
    The custom features for this device and their values.
    CustomFeatures property will be removed completely in a future version of the SDK. CustomFeatures property is only used by AutoHos, for which GoDevice#autoHos property was added. Backward compatibility for CustomFeatures is ensured: autoHos property takes precedence over customFeatures when both are set, otherwise customFeatures.
  - customProperties
```
protected List<PropertyValue> customProperties
```
    The set of dynamic, user created, custom properties.
  - mediaFiles
```
protected List<MediaFile> mediaFiles
```
    The list of MediaFile for this asset.
- Constructor Detail
  - Device
```
public Device()
```
- Method Detail
  - deviceTypeFromProductId
```
public static DeviceType deviceTypeFromProductId(int productId)
```
    Maps the given productId to a DeviceType.
    
    Parameters:
    
    productId - The device product Id.
    
    Returns:
    
    The DeviceType
  - productIdFromSerialNumber
```
public static int productIdFromSerialNumber(String serialNumber)
```
    Returns the product id from its serial number.
    
    Parameters:
    
    serialNumber - The serial number.
    
    Returns:
    
    Internal product Id for a serial number
  - prefixFromDeviceType
```
public static String prefixFromDeviceType(int productId)
```
    Returns the string prefix of the given product ID.
    
    Parameters:
    
    productId - Internal product Id for a serial number
    
    Returns:
    
    A serial number prefix.
  - isNoGpsDevice
```
public boolean isNoGpsDevice()
```
    Determine if a device is NoGps Device by its productId.
    
    Returns:
    
    true | false
  - fromSerialNumber
```
public static Device fromSerialNumber(String serialNumber)
```
    Returns the correct type of device for the given serial number.
    
    Parameters:
    
    serialNumber - The serial number for the device. For example, GV-001-000-0000.
    
    Returns:
    
    An instance of Device object that corresponds to the serial number provided
  - populateDefaults
```
public void populateDefaults()
```
    Set default values for the Device instance.
  - fromProductId
```
public static Device fromProductId(int productId)
```
    Get the correct Device object from the given product Id.
    
    Parameters:
    
    productId - Product id.
    
    Returns:
    
    Device instance

Class Device

Nested Class Summary

Nested classes/interfaces inherited from class com.geotab.model.entity.Entity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.geotab.model.entity.Entity

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_NO_LOG_SECONDS

MAX_DATE

MIN_DATE

HISTORIC_SERIAL_NUMBER

HISTORIC_MIN

HISTORIC_MAX

CUSTOM_DEVICE_PRODUCT_ID

GO_DRIVE_PRODUCT_ID

GO_DRIVE_PREFIX

GO2_PRODUCT_ID

GO2_PREFIX

GO3_PRODUCT_ID

GO3_PREFIX

GO4_PRODUCT_ID

GO4_PREFIX

GO4_V3_PRODUCT_ID

GO4_V3_PREFIX

GO5_PRODUCT_ID

GO5_PREFIX

GO6_PRODUCT_ID

GO6_PREFIX

GO7_PRODUCT_ID

GO7_PREFIX

GO8_PRODUCT_ID

GO8_PREFIX

GO8_PRODUCT_ID_NO_GPS

GO9_PRODUCT_ID

GO9_PREFIX

GO9B_PRODUCT_ID

GO9B_PREFIX

GO10_PRODUCT_ID

GO10_PREFIX

A1_PREFIX

A1_PRODUCT_ID

U1_PREFIX

U1_PRODUCT_ID

GO9_PRODUCT_ID_NO_GPS

GO_MAX_PRODUCT_ID

UNTRACKED_ASSET_PRODUCT_ID

UNTRACKED_ASSET_HARDWARE_ID

OLD_GEOTAB_PRODUCT_ID

GO_PREFIX_TO_PRODUCT_ID_MAPPING

deviceType

productId

serialNumber

ignoreDownloadsUntil

timeToDownload

workTime

groups

devicePlans

devicePlanBillingInfo

timeZoneId

minSecondsBetweenLogs

maxSecondsBetweenLogs

activeFrom

activeTo

comment

deviceFlags

customFeatures

customProperties

mediaFiles

Constructor Detail

Device

Method Detail

deviceTypeFromProductId

productIdFromSerialNumber

prefixFromDeviceType

isNoGpsDevice

fromSerialNumber

populateDefaults

fromProductId