MeStepperOnBoard.h File Reference

Header for MeStepperOnBoard.cpp module. More...

#include "WProgram.h"
#include "stdlib.h"
#include "wiring.h"

Include dependency graph for MeStepperOnBoard.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	megaPi_slot
class	MeStepperOnBoard
	Driver for Me Stepper on MegaPi. More...

Macros
#define	NUM_SLOTS   4
#define	SLOT_NUM_PINS   8

Typedefs
typedef struct megaPi_slot	megaPi_slot_type
typedef void(*	cb) (int, int)

Variables
megaPi_slot_type	megaPi_slots [NUM_SLOTS]

Detailed Description

Header for MeStepperOnBoard.cpp module.

Author

MakeBlock

Version

V1.0.3

Date

2018/01/03

Copyright

This software is Copyright (C), 2012-2016, MakeBlock. Use is subject to license
conditions. The main licensing options available are GPL V2 or Commercial:

Open Source Licensing GPL V2

This is the appropriate option if you want to share the source code of your
application with everyone you distribute it to, and you also want to give them
the right to share who uses it. If you wish to use this software under Open
Source Licensing, you must contribute all your source code to the open source
community in accordance with the GPL Version 2 when your application is
distributed. See http://www.gnu.org/copyleft/gpl.html

Description

This file is a drive for Me Stepper device.

Method List:

1. void MeStepperOnBoard::setMicroStep(int8_t value);
2. void MeStepperOnBoard::setpin(int slot);
3. void MeStepperOnBoard::moveTo(long absolute);
4. void MeStepperOnBoard::moveTo(long absolute, int16_t extId, cb callback);
5. void MeStepperOnBoard::move(long relative);
6. void MeStepperOnBoard::move(long relative, int16_t extId, cb callback);
7. boolean MeStepperOnBoard::run(void);
8. boolean MeStepperOnBoard::runSpeed(void);
9. void MeStepperOnBoard::setMaxSpeed(float speed);
10. void MeStepperOnBoard::setAcceleration(float acceleration);
11. void MeStepperOnBoard::setSpeed(float speed);
12. float MeStepperOnBoard::speed(void);
13. long MeStepperOnBoard::distanceToGo(void);
14. long MeStepperOnBoard::targetPosition(void);
15. long MeStepperOnBoard::currentPosition(void);
    
16. void MeStepperOnBoard::setCurrentPosition(long position);
    
17. void MeStepperOnBoard::runToPosition(void);
18. boolean MeStepperOnBoard::runSpeedToPosition(void);
19. void MeStepperOnBoard::runToNewPosition(long position);
20. void MeStepperOnBoard::disableOutputs(void);
21. void MeStepperOnBoard::enableOutputs(void);
22. void MeStepperOnBoard::update(void);
23. int16_t MeStepperOnBoard::getPort(void);

History:

`<Author>`         `<Time>`        `<Version>`        `<Descr>`
Mark Yan        2016/03/05     1.0.0            Bulid the new
Mark Yan        2016/05/06     1.0.1            Add function move and moveTo
Zzipeng         2017/02/20     1.0.2            put the array megaPi_slots[4] to MegaPi.h/MegaPiPro.h
Mark Yan        2018/01/03     1.0.3            Change the parameters order of moveTo/move