Skip to content

bluerover/java-bluerover-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BlueRover Java API

Java wrapper for connecting to the blueRover API.

Dependencies (in /lib)

  • gson-2.2.4
  • commons-codec-1.9

Public Methods

  • BlueroverApi api.setCredentials(creds)

    Sets the credentials of the Bluerover API object.

    Parameters:

    HashMap<String,String> creds : API credentials containing the following:

    *   `String key` : authentication key for your user
    *   `String token` : authentication token for your user
    *   `String baseURL` : the address where you are pointing to, normally **developers.bluerover.us**
    

    Returns: BlueroverApi object

  • void api.clearCredentials()

    Parameters: None

    Remove the key and token values from the API object.

  • Result<Event[]> api.getEvents(startTime,endTime,page)

    API Request to get events from a particular date range.

    Parameters:

    * `String startTime` : beginning of the date range
    * `String endTime` : end of the date range
    * `String page` : the particular page of results that you want (starts at page 0)
    

    startTime and endTime are both in UNIX timestamp format

    Returns: Result<Event[]> object containing an array of events

  • Result<Device[]> api.getDevices()

    API Request to get a list of devices for the user

    Parameters: None

    Returns: Result<Device[]> object containing an array of devices

  • Result<Rfid[]> api.getRfids()

    API Request to get a list of rfids for the user

    Parameters: None

    Returns: Result<Rfid[]> object containing an array of rfids

  • Result<Event[]> api.next(pResult)

    API Request to get the next page of events.

    Parameters:

    * `Result<Event[]> pResult` : Result object of the previous page of events
    

    Returns: Result<Event[]> object containing an array of events

  • void api.getEventStream(pCallBack)

    API Request to start the event stream, calling pCallBack when data is received.

    Define pCallBack by implementing the CallBack class.

    Parameters:

    * `CallBack pCallBack` : Implementation of CallBack that defines behaviour on data received
    

Models

###Result

  • T list - Represents the json decoded data returned the API server

    Based on the function you call, the list property will represent an array of Event, Device or Rfid java objects

  • JsonObject jsonObject - a GSON jSON object that encapsulates the API's response

  • JsonArray jsonArray - a GSON jSON array that encapsulates the API's response

  • HttpRequest request - copy of the request made to the API

  • HttpResponse response - copy of the response made to the API

  • HttpRequest next - a request object that can be used to get the next page of results (for Event[])

  • String rawResponse - the raw data string that came from the API's response

Note: either jsonObject or jsonArray will contain data, the other will be null. This is due to the format returned by the API.

###Event

  • String deviceId
  • long autoIndex
  • int statusCode
  • long timestamp
  • long creationTime
  • int geozoneIndex
  • String geozoneID
  • String transportID
  • int inputMask
  • int seqNum
  • String dataSource
  • String charDeviceType
  • String charDeviceResponse
  • float heading
  • String address
  • int rfidCustNum
  • int rfidTagNum
  • int rfidAlarmFlags
  • int rfidBatteryStatus
  • int rfidRssi
  • int rfidReaderId
  • int rfidReaderType
  • float rfidTemperature
  • float longitude
  • float latitude
  • float altitude
  • float speedKPH
  • float odometerKM
  • float distanceKM
  • float zone1Avr
  • float zone2Avr
  • float zone3Avr
  • float zone4Avr
  • float zone5Avr
  • float zone6Avr
  • float zone7Avr
  • float zone8Avr
  • float zone1Low
  • float zone2Low
  • float zone3Low
  • float zone4Low
  • float zone5Low
  • float zone6Low
  • float zone7Low
  • float zone8Low
  • float zone1High
  • float zone2High
  • float zone3High
  • float zone4High
  • float zone5High
  • float zone6High
  • float zone7High
  • float zone8High
  • String rawData

###Device

  • char isSpeedActive
  • int totalMaxConnPerMin
  • int vehicleID
  • String notes
  • char deviceAlertActive
  • int supportsDMTP
  • float staticLongitude
  • float lastValidLongitude
  • int unitLimitInterval
  • String lastAckCommand
  • String notify
  • int uniqueID
  • String featureSet
  • int duplexMaxConnPerMin
  • float speedThreshold
  • String smsEmail
  • long simPhoneNumber
  • int speedWindow
  • String duplexProfileMask
  • String pendingPingCommand
  • float staticLatitude
  • String imeiNumber
  • int maxAllowedEvents
  • String ipAddressCurrent
  • String totalProfileMask
  • String deviceType
  • char isActive
  • char isLandmarkActive
  • long lastOdometerKM
  • int listenPortCurrent
  • long odometerOffsetKM
  • String accountID
  • int timeInterval
  • char isStatic
  • char expectAck
  • String description
  • int codeVersion
  • String driverID
  • int remotePortCurrent
  • double lastUpdateTime
  • double lastConnectionTime
  • String assetTypeCode
  • String pushpinID
  • double lastPingTime
  • long totalPingCount
  • double lastDuplexConnectTime
  • String dcsConfigMask
  • String doh
  • double lastAckTime
  • String displayName
  • String supportedEncodings
  • int ipAddressValid
  • double lastGPSTimestamp
  • int totalMaxConn
  • String serialNumber
  • double creationTime
  • int equipmentType
  • String ignitionIndex
  • String deviceID
  • String deviceCode
  • int maxPingCount
  • int duplexMaxConn
  • String groupID
  • int lastInputState
  • float lastValidLatitude

###Rfid

Coming soon.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages