Class: Phidgets::InterfaceKit::InterfaceKitSensors

Inherits:
Object
  • Object
show all
Defined in:
lib/phidgets-ffi/interface_kit.rb

Overview

This class represents an analog sensor for a PhidgetInterfaceKit. All the properties of an analog sensor are stored and modified in this class.

Constant Summary collapse

Klass = 
Phidgets::FFI::CPhidgetInterfaceKit

Instance Method Summary collapse

Instance Method Details

#data_rate ⇒ Integer

Returns data rate of the analog input, or raises an error.

Returns:

  • (Integer) —

    returns data rate of the analog input, or raises an error.



251
252
253
254
255
 
# File 'lib/phidgets-ffi/interface_kit.rb', line 251

def data_rate
  ptr = ::FFI::MemoryPointer.new(:int)
  Klass.getDataRate(@handle, @index, ptr)
  ptr.get_int(0)
end

#data_rate=(new_data_rate) ⇒ Integer

Sets the data rate of the analog input, or raises an error.

Parameters:

  • new_data_rate (Integer) —

    data rate

Returns:

  • (Integer) —

    returns the data rate of the analog input, or raises an error.



260
261
262
263
 
# File 'lib/phidgets-ffi/interface_kit.rb', line 260

def data_rate=(new_data_rate)
  Klass.setDataRate(@handle, @index, new_data_rate.to_i)
  new_data_rate.to_i
end

#data_rate_max ⇒ Integer

Returns maximum data rate of the analog input, or raises an error.

Returns:

  • (Integer) —

    returns maximum data rate of the analog input, or raises an error.



273
274
275
276
277
 
# File 'lib/phidgets-ffi/interface_kit.rb', line 273

def data_rate_max
  ptr = ::FFI::MemoryPointer.new(:int)
  Klass.getDataRateMax(@handle, @index, ptr)
  ptr.get_int(0)
end

#data_rate_min ⇒ Integer

Returns minimum data rate of the analog input, or raises an error.

Returns:

  • (Integer) —

    returns minimum data rate of the analog input, or raises an error.



266
267
268
269
270
 
# File 'lib/phidgets-ffi/interface_kit.rb', line 266

def data_rate_min
  ptr = ::FFI::MemoryPointer.new(:int)
  Klass.getDataRateMin(@handle, @index, ptr)
  ptr.get_int(0)
end

#index ⇒ Integer

Returns index of the analog input, or raises an error.

Returns:

  • (Integer) —

    returns index of the analog input, or raises an error.



216
217
218
 
# File 'lib/phidgets-ffi/interface_kit.rb', line 216

def index 
	@index
end

#inspect ⇒ Object

Displays data for the analog sensor



211
212
213
 
# File 'lib/phidgets-ffi/interface_kit.rb', line 211

def inspect
  "#<#{self.class} @value=#{value}, @raw_value=#{raw_value}, @data_rate=#{data_rate}, @sensitivity=#{sensitivity}, @data_rate_max=#{data_rate_max}, @data_rate_min=#{data_rate_min}>"
end

#raw_value ⇒ Integer

Returns raw value of the analog input, or raises an error.

Returns:

  • (Integer) —

    returns raw value of the analog input, or raises an error.



229
230
231
232
233
 
# File 'lib/phidgets-ffi/interface_kit.rb', line 229

def raw_value
  ptr = ::FFI::MemoryPointer.new(:int)
  Klass.getSensorRawValue(@handle, @index, ptr)
  ptr.get_int(0)
end

#sensitivity ⇒ Integer

Returns sensitivity of the analog input, or raises an error.

Returns:

  • (Integer) —

    returns sensitivity of the analog input, or raises an error.



236
237
238
239
240
 
# File 'lib/phidgets-ffi/interface_kit.rb', line 236

def sensitivity
  ptr = ::FFI::MemoryPointer.new(:int)
  Klass.getSensorChangeTrigger(@handle, @index, ptr)
  ptr.get_int(0)
end

#sensitivity=(new_sensitivity) ⇒ Integer

Sets the sensitivity of the analog input, or raises an error.

Parameters:

  • new_sensitivity (Integer) —

    new sensitivity

Returns:

  • (Integer) —

    returns sensitivity of the analog input, or raises an error.



245
246
247
248
 
# File 'lib/phidgets-ffi/interface_kit.rb', line 245

def sensitivity=(new_sensitivity)
  Klass.setSensorChangeTrigger(@handle, @index, new_sensitivity.to_i)
  new_sensitivity.to_i
end

#value ⇒ Integer Also known as: to_i

Returns value of the analog input, or raises an error.

Returns:

  • (Integer) —

    returns value of the analog input, or raises an error.



221
222
223
224
225
 
# File 'lib/phidgets-ffi/interface_kit.rb', line 221

def value
  ptr = ::FFI::MemoryPointer.new(:int)
  Klass.getSensorValue(@handle, @index, ptr)
  ptr.get_int(0)
end