My Version of the Crealab MotorLib.

Fork of MotorLib by CreaLab

Embed: (wiki syntax)

« Back to documentation index

CreaMot.h File Reference

CreaMot.h File Reference

File contains Crealab CreaMot Library. More...

Go to the source code of this file.

Data Structures

class  CreaMot
 ATTENTION UNDER CONSTRUCTION, DO NOT YET USE. More...

Enumerations

enum  motStates { Motor_OFF = 0, Motor_ZERO, Motor_ON, Motor_RUN }
 

Possible States of CreaMot state machine.

More...
enum  motCmands { MOTOR_nop = 0, MOTOR_run, MOTOR_stop, MOTOR_pause }
 

Commands that are handled by the CreaMot state machine.

More...

Detailed Description

File contains Crealab CreaMot Library.

CreaMot.h contains the class CreaMot, and related enums and structs. Includes only "mbed.h".

MotStatus structure is dissolved into the CreaMot Class

Rotation directions are now consistently called Clockwise, and Counterclockwise (CCW), instead of mix them with Left and Right. Doxygens Tags are preceeded by either a backslash \ or by an at symbol @.

Author:
Tarek Lule, Francois Druilhe, et al.
Date:
01. Nov. 2018.
See also:
https://os.mbed.com/users/sepp_nepp/code/MotorLib/

Definition in file CreaMot.h.


Enumeration Type Documentation

enum motCmands

Commands that are handled by the CreaMot state machine.

These Commands are issued asynchonously by calling CreaMot class methods. They are executed in the state machine called by the ticker handler.

OFF and STOP commands do not go through the state machine.

MOTOR_restart is equivalent to and replaced by MOTOR_run.

Enumerator:
MOTOR_nop 

No active command to execute.

MOTOR_run 

Run CreaMot until Nsteps are achieved.

MOTOR_stop 

Stop immediately all activity, turn off CreaMot.

MOTOR_pause 

CreaMot is temporarily paused from the state run.

Definition at line 56 of file CreaMot.h.

enum motStates

Possible States of CreaMot state machine.

Motor_CALIB is deprecated, was removed from the enum structure

Enumerator:
Motor_OFF 

All phase currents is off, replaces Motor_STOP.

Motor_ZERO 

CreaMot at phase position 0 and ON, only reached by call of Zero() procedure.

Motor_ON 

Phases are engaged, but CreaMot state machine stopped, replaces Motor_PAUSE.

Motor_RUN 

Phases are engaged, and CreaMot state machine runs.

Definition at line 39 of file CreaMot.h.