Haply hAPI  V4.0
Haply Haptic API
Sensor Class Reference

Public Member Functions

 Sensor ()
 
 Sensor (int encoder, int direction, float offset, float resolution, int port)
 
void set_encoder (int encoder)
 
void set_direction (int direction)
 
void set_offset (float offset)
 
void set_resolution (float resolution)
 
void set_port (int port)
 
void set_value (float value)
 
int get_encoder ()
 
int get_direction ()
 
float get_offset ()
 
float get_resolution ()
 
int get_port ()
 
float get_value ()
 

Constructor & Destructor Documentation

◆ Sensor() [1/2]

Sensor.Sensor ( )

Constructs a Sensor set using motor port position one

◆ Sensor() [2/2]

Sensor.Sensor ( int  encoder,
int  direction,
float  offset,
float  resolution,
int  port 
)

Constructs a Sensor with the given motor port position, to be initialized with the given angular offset, at the specified step resolution (used for construction of encoder sensor)

Parameters
encoderencoder index
offsetinitial offset in degrees that the encoder sensor should be initialized at
resolutionstep resolution of the encoder sensor
portspecific motor port the encoder sensor is connect at (usually same as actuator)

Member Function Documentation

◆ get_direction()

int Sensor.get_direction ( )
Returns
encoder direction

◆ get_encoder()

int Sensor.get_encoder ( )
Returns
encoder index

◆ get_offset()

float Sensor.get_offset ( )
Returns
current offset parameter

◆ get_port()

int Sensor.get_port ( )
Returns
current motor port position

◆ get_resolution()

float Sensor.get_resolution ( )
Returns
encoder resolution of encoder sensor being used

◆ get_value()

float Sensor.get_value ( )
Returns
current sensor value information

◆ set_direction()

void Sensor.set_direction ( int  direction)

Set encoder direction of detection

Parameters
encoderindex

◆ set_encoder()

void Sensor.set_encoder ( int  encoder)

Set encoder index parameter of sensor

Parameters
encoderindex

◆ set_offset()

void Sensor.set_offset ( float  offset)

Set encoder offset parameter of sensor

Parameters
offsetinitial angular offset in degrees

◆ set_port()

void Sensor.set_port ( int  port)

Set motor port position to be used by sensor

Parameters
portmotor port position (motor port connection on Haply board)

◆ set_resolution()

void Sensor.set_resolution ( float  resolution)

Set encoder resolution parameter of sensor

Parameters
resolutionstep resolution of encoder sensor

◆ set_value()

void Sensor.set_value ( float  value)

Set sensor value variable to the specified input

Parameters
valuesensor value

The documentation for this class was generated from the following file: