Class: Samsara::Types::EquipmentStatsListResponseData

Inherits:
Object
  • Object
show all
Defined in:
lib/samsara_api/types/equipment_stats_list_response_data.rb

Overview

A unit of equipment and its time-series of stats events.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(engine_rpm: OMIT, engine_seconds: OMIT, engine_states: OMIT, engine_total_idle_time_minutes: OMIT, fuel_percents: OMIT, gateway_engine_seconds: OMIT, gateway_engine_states: OMIT, gateway_j_1939_engine_seconds: OMIT, gps: OMIT, gps_odometer_meters: OMIT, id:, name:, obd_engine_seconds: OMIT, obd_engine_states: OMIT, additional_properties: nil) ⇒ Samsara::Types::EquipmentStatsListResponseData

Parameters:

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 85

def initialize(engine_rpm: OMIT, engine_seconds: OMIT, engine_states: OMIT, engine_total_idle_time_minutes: OMIT, fuel_percents: OMIT, gateway_engine_seconds: OMIT, gateway_engine_states: OMIT, gateway_j_1939_engine_seconds: OMIT, gps: OMIT, gps_odometer_meters: OMIT, id:, name:, obd_engine_seconds: OMIT, obd_engine_states: OMIT, additional_properties: nil)
  @engine_rpm = engine_rpm if engine_rpm != OMIT
  @engine_seconds = engine_seconds if engine_seconds != OMIT
  @engine_states = engine_states if engine_states != OMIT
  @engine_total_idle_time_minutes = engine_total_idle_time_minutes if engine_total_idle_time_minutes != OMIT
  @fuel_percents = fuel_percents if fuel_percents != OMIT
  @gateway_engine_seconds = gateway_engine_seconds if gateway_engine_seconds != OMIT
  @gateway_engine_states = gateway_engine_states if gateway_engine_states != OMIT
  @gateway_j_1939_engine_seconds = gateway_j_1939_engine_seconds if gateway_j_1939_engine_seconds != OMIT
  @gps = gps if gps != OMIT
  @gps_odometer_meters = gps_odometer_meters if gps_odometer_meters != OMIT
  @id = id
  @name = name
  @obd_engine_seconds = obd_engine_seconds if obd_engine_seconds != OMIT
  @obd_engine_states = obd_engine_states if obd_engine_states != OMIT
  @additional_properties = additional_properties
  @_field_set = { "engineRpm": engine_rpm, "engineSeconds": engine_seconds, "engineStates": engine_states, "engineTotalIdleTimeMinutes": engine_total_idle_time_minutes, "fuelPercents": fuel_percents, "gatewayEngineSeconds": gateway_engine_seconds, "gatewayEngineStates": gateway_engine_states, "gatewayJ1939EngineSeconds": gateway_j_1939_engine_seconds, "gps": gps, "gpsOdometerMeters": gps_odometer_meters, "id": id, "name": name, "obdEngineSeconds": obd_engine_seconds, "obdEngineStates": obd_engine_states }.reject do | _k, v |
  v == OMIT
end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



56
57
58
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 56

def additional_properties
  @additional_properties
end

#engine_rpm ⇒ Array<Samsara::Types::EquipmentEngineRpm> (readonly)

Returns A time-series of engine RPM readings for the given unit of equipment.

Returns:



22
23
24
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 22

def engine_rpm
  @engine_rpm
end

#engine_seconds ⇒ Object (readonly)

gatewayJ1939EngineSeconds.



25
26
27
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 25

def engine_seconds
  @engine_seconds
end

#engine_states ⇒ Array<Samsara::Types::EquipmentEngineState> (readonly)

Returns [DEPRECATED] Please use either gatewayEngineStates or obdEngineStates.

Returns:



27
28
29
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 27

def engine_states
  @engine_states
end

#engine_total_idle_time_minutes ⇒ Array<Samsara::Types::EquipmentEngineTotalIdleTimeMinutes> (readonly)

Returns A time-series of engine total idle time minutes. (Beta).

Returns:



29
30
31
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 29

def engine_total_idle_time_minutes
  @engine_total_idle_time_minutes
end

#fuel_percents ⇒ Array<Samsara::Types::EquipmentFuelPercent> (readonly)

Returns A time-series of fuel percent level changes for the given unit of equipment.

Returns:



31
32
33
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 31

def fuel_percents
  @fuel_percents
end

#gateway_engine_seconds ⇒ Object (readonly)

approximate based on readings from the AG26's aux/digio cable.



34
35
36
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 34

def gateway_engine_seconds
  @gateway_engine_seconds
end

#gateway_engine_states ⇒ Object (readonly)

for the given unit of equipment.



37
38
39
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 37

def gateway_engine_states
  @gateway_engine_states
end

#gateway_j_1939_engine_seconds ⇒ Object (readonly)

approximate based on readings from the AG26's CAT/J1939 cable.



40
41
42
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 40

def gateway_j_1939_engine_seconds
  @gateway_j_1939_engine_seconds
end

#gps ⇒ Array<Samsara::Types::EquipmentStatsGps> (readonly)

Returns A time-series of GPS locations.

Returns:



42
43
44
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 42

def gps
  @gps
end

#gps_odometer_meters ⇒ Array<Samsara::Types::EquipmentGpsOdometerMeters> (readonly)

Returns A time-series of GPS odometer readings for the given unit of equipment.

Returns:



44
45
46
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 44

def gps_odometer_meters
  @gps_odometer_meters
end

#id ⇒ String (readonly)

Returns:

  • (String) 


46
47
48
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 46

def id
  @id
end

#name ⇒ String (readonly)

Returns:

  • (String) 


48
49
50
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 48

def name
  @name
end

#obd_engine_seconds ⇒ Object (readonly)

directly from on-board diagnostics.



51
52
53
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 51

def obd_engine_seconds
  @obd_engine_seconds
end

#obd_engine_states ⇒ Object (readonly)

the given unit of equipment.



54
55
56
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 54

def obd_engine_states
  @obd_engine_states
end

Class Method Details

.from_json(json_object:) ⇒ Samsara::Types::EquipmentStatsListResponseData

Parameters:

  • json_object (String)

Returns:



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 109

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  engine_rpm = parsed_json["engineRpm"]&.map do | item |
  item = item.to_json
  Samsara::Types::EquipmentEngineRpm.from_json(json_object: item)
end
  engine_seconds = parsed_json["engineSeconds"]&.map do | item |
  item = item.to_json
  Samsara::Types::EquipmentEngineSeconds.from_json(json_object: item)
end
  engine_states = parsed_json["engineStates"]&.map do | item |
  item = item.to_json
  Samsara::Types::EquipmentEngineState.from_json(json_object: item)
end
  engine_total_idle_time_minutes = parsed_json["engineTotalIdleTimeMinutes"]&.map do | item |
  item = item.to_json
  Samsara::Types::EquipmentEngineTotalIdleTimeMinutes.from_json(json_object: item)
end
  fuel_percents = parsed_json["fuelPercents"]&.map do | item |
  item = item.to_json
  Samsara::Types::EquipmentFuelPercent.from_json(json_object: item)
end
  gateway_engine_seconds = parsed_json["gatewayEngineSeconds"]&.map do | item |
  item = item.to_json
  Samsara::Types::EquipmentGatewayEngineSeconds.from_json(json_object: item)
end
  gateway_engine_states = parsed_json["gatewayEngineStates"]&.map do | item |
  item = item.to_json
  Samsara::Types::EquipmentGatewayEngineState.from_json(json_object: item)
end
  gateway_j_1939_engine_seconds = parsed_json["gatewayJ1939EngineSeconds"]&.map do | item |
  item = item.to_json
  Samsara::Types::EquipmentGatewayJ1939EngineSeconds.from_json(json_object: item)
end
  gps = parsed_json["gps"]&.map do | item |
  item = item.to_json
  Samsara::Types::EquipmentStatsGps.from_json(json_object: item)
end
  gps_odometer_meters = parsed_json["gpsOdometerMeters"]&.map do | item |
  item = item.to_json
  Samsara::Types::EquipmentGpsOdometerMeters.from_json(json_object: item)
end
  id = parsed_json["id"]
  name = parsed_json["name"]
  obd_engine_seconds = parsed_json["obdEngineSeconds"]&.map do | item |
  item = item.to_json
  Samsara::Types::EquipmentObdEngineSeconds.from_json(json_object: item)
end
  obd_engine_states = parsed_json["obdEngineStates"]&.map do | item |
  item = item.to_json
  Samsara::Types::EquipmentObdEngineState.from_json(json_object: item)
end
  new(
    engine_rpm: engine_rpm,
    engine_seconds: engine_seconds,
    engine_states: engine_states,
    engine_total_idle_time_minutes: engine_total_idle_time_minutes,
    fuel_percents: fuel_percents,
    gateway_engine_seconds: gateway_engine_seconds,
    gateway_engine_states: gateway_engine_states,
    gateway_j_1939_engine_seconds: gateway_j_1939_engine_seconds,
    gps: gps,
    gps_odometer_meters: gps_odometer_meters,
    id: id,
    name: name,
    obd_engine_seconds: obd_engine_seconds,
    obd_engine_states: obd_engine_states,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 192

def self.validate_raw(obj:)
  obj.engine_rpm&.is_a?(Array) != false || raise("Passed value for field obj.engine_rpm is not the expected type, validation failed.")
  obj.engine_seconds&.is_a?(Array) != false || raise("Passed value for field obj.engine_seconds is not the expected type, validation failed.")
  obj.engine_states&.is_a?(Array) != false || raise("Passed value for field obj.engine_states is not the expected type, validation failed.")
  obj.engine_total_idle_time_minutes&.is_a?(Array) != false || raise("Passed value for field obj.engine_total_idle_time_minutes is not the expected type, validation failed.")
  obj.fuel_percents&.is_a?(Array) != false || raise("Passed value for field obj.fuel_percents is not the expected type, validation failed.")
  obj.gateway_engine_seconds&.is_a?(Array) != false || raise("Passed value for field obj.gateway_engine_seconds is not the expected type, validation failed.")
  obj.gateway_engine_states&.is_a?(Array) != false || raise("Passed value for field obj.gateway_engine_states is not the expected type, validation failed.")
  obj.gateway_j_1939_engine_seconds&.is_a?(Array) != false || raise("Passed value for field obj.gateway_j_1939_engine_seconds is not the expected type, validation failed.")
  obj.gps&.is_a?(Array) != false || raise("Passed value for field obj.gps is not the expected type, validation failed.")
  obj.gps_odometer_meters&.is_a?(Array) != false || raise("Passed value for field obj.gps_odometer_meters is not the expected type, validation failed.")
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.obd_engine_seconds&.is_a?(Array) != false || raise("Passed value for field obj.obd_engine_seconds is not the expected type, validation failed.")
  obj.obd_engine_states&.is_a?(Array) != false || raise("Passed value for field obj.obd_engine_states is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


183
184
185
 
# File 'lib/samsara_api/types/equipment_stats_list_response_data.rb', line 183

def to_json
  @_field_set&.to_json
end