Robotique FIP / Easyspin_lib

Speed profile working

Fork of Easyspin_lib by Julien Tiron

Embed: (wiki syntax)

« Back to documentation index

Easyspin control functions
Functions

Easyspin control functions

Functions

void CmdDisable (uint8_t shieldId)
 Issue the Disable command to the Easyspin of the specified shield.
void CmdEnable (uint8_t shieldId)
 Issues the Enable command to the Easyspin of the specified shield.
uint32_t CmdGetParam (uint8_t shieldId, Easyspin_Registers_t param)
 Issues the GetParam command to the Easyspin of the specified shield.
uint16_t CmdGetStatus (uint8_t shieldId)
 Issues the GetStatus command to the Easyspin of the specified shield.
void CmdNop (uint8_t shieldId)
 Issues the Nop command to the Easyspin of the specified shield.
void CmdSetParam (uint8_t shieldId, Easyspin_Registers_t param, uint32_t value)
 Issues the SetParam command to the Easyspin of the specified shield.
uint16_t ReadStatusRegister (uint8_t shieldId)
 Reads the Status Register value.
void Reset (void)
 Resets the Easyspin (reset pin set to low) of all shields.
void ReleaseReset (void)
 Releases the Easyspin reset (pin set to High) of all shields.
void SelectStepMode (uint8_t shieldId, Easyspin_STEP_SEL_t stepMod)
 Set the stepping mode.
void SetDirection (uint8_t shieldId, dir_t direction)
 Specifies the direction.

Function Documentation

void CmdDisable ( uint8_t  shieldId ) [inherited]

Issue the Disable command to the Easyspin of the specified shield.

Parameters:
[in]shieldId(from 0 to 2)
Return values:
None

Definition at line 540 of file easyspin.cpp.

void CmdEnable ( uint8_t  shieldId ) [inherited]

Issues the Enable command to the Easyspin of the specified shield.

Parameters:
[in]shieldId(from 0 to 2)
Return values:
None

Definition at line 550 of file easyspin.cpp.

uint32_t CmdGetParam ( uint8_t  shieldId,
Easyspin_Registers_t  param 
) [inherited]

Issues the GetParam command to the Easyspin of the specified shield.

Parameters:
[in]shieldId(from 0 to 2)
[in]paramRegister adress (Easyspin_ABS_POS, Easyspin_MARK,...)
Return values:
Registervalue

Definition at line 561 of file easyspin.cpp.

uint16_t CmdGetStatus ( uint8_t  shieldId ) [inherited]

Issues the GetStatus command to the Easyspin of the specified shield.

Parameters:
[in]shieldId(from 0 to 2)
Return values:
StatusRegister value
Note:
Once the GetStatus command is performed, the flags of the status register are reset. This is not the case when the status register is read with the GetParam command (via the functions ReadStatusRegister or CmdGetParam).

Definition at line 637 of file easyspin.cpp.

void CmdNop ( uint8_t  shieldId ) [inherited]

Issues the Nop command to the Easyspin of the specified shield.

Parameters:
[in]shieldId(from 0 to 2)
Return values:
None

Definition at line 683 of file easyspin.cpp.

void CmdSetParam ( uint8_t  shieldId,
Easyspin_Registers_t  param,
uint32_t  value 
) [inherited]

Issues the SetParam command to the Easyspin of the specified shield.

Parameters:
[in]shieldId(from 0 to 2)
[in]paramRegister adress (Easyspin_ABS_POS, Easyspin_MARK,...)
[in]valueValue to set in the register
Return values:
None

Definition at line 695 of file easyspin.cpp.

uint16_t ReadStatusRegister ( uint8_t  shieldId ) [inherited]

Reads the Status Register value.

Parameters:
[in]shieldId(from 0 to 2)
Return values:
Statusregister valued
Note:
The status register flags are not cleared at the difference with CmdGetStatus()

Definition at line 761 of file easyspin.cpp.

void ReleaseReset ( void   ) [inherited]

Releases the Easyspin reset (pin set to High) of all shields.

Parameters:
None
Return values:
None

Definition at line 771 of file easyspin.cpp.

void Reset ( void   ) [inherited]

Resets the Easyspin (reset pin set to low) of all shields.

Parameters:
None
Return values:
None

Definition at line 781 of file easyspin.cpp.

void SelectStepMode ( uint8_t  shieldId,
Easyspin_STEP_SEL_t  stepMod 
) [inherited]

Set the stepping mode.

Parameters:
[in]shieldId(from 0 to 2)
[in]stepModfrom full step to 1/16 microstep as specified in enum Easyspin_STEP_SEL_t
Return values:
None

Definition at line 792 of file easyspin.cpp.

void SetDirection ( uint8_t  shieldId,
dir_t  dir 
) [inherited]

Specifies the direction.

Parameters:
[in]shieldId(from 0 to 2)
[in]dirFORWARD or BACKWARD
Note:
The direction change is only applied if the shield is in INACTIVE state
Return values:
None

Definition at line 819 of file easyspin.cpp.

Generated on Tue Jul 12 2022 21:33:48 by  doxygen 1.7.2