Kazutaka "Zak" Sawa / XBusServo

Library for XBus servo (under construction)

Dependents:   mbed_XBus_Test mbed_XBus_MotionTest XBusServoTest ControlYokutan2017_2 ... more

It's pre-opened page. it's still a little bit unstable to use command packet but mostly work. Tested only on KL25Z

暫定版ページです。 まだコマンドパケット使用時に時々不安定になりますが、概ね動作しています。 KL25Z上でのみ、動作確認しています

XBusServo.h@4:d88f498d259b, 2014-10-08 (annotated)

Committer:
sawa
Date:
Wed Oct 08 03:47:41 2014 +0000
Revision:
4:d88f498d259b
Parent:
3:9a10ad81d04e
Child:
5:7246a46379f7
doxygen test

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sawa 3:9a10ad81d04e 1 /**
sawa 3:9a10ad81d04e 2 * @file XBusServo.h
sawa 3:9a10ad81d04e 3 * @brief this header file will contain all required
sawa 3:9a10ad81d04e 4 * definitions and basic utilities functions.
sawa 3:9a10ad81d04e 5 * @author Zak Sawa
sawa 3:9a10ad81d04e 6 * @note Copyright (c) 2014-2014 JR PROPO
sawa 3:9a10ad81d04e 7 * @note Released under the MIT License: http://mbed.org/license/mit
sawa 0:381d475cfd6c 8 */
sawa 0:381d475cfd6c 9 #ifndef XBusServo_h
sawa 0:381d475cfd6c 10 #define XBusServo_h
sawa 0:381d475cfd6c 11
sawa 0:381d475cfd6c 12 #include "mbed.h"
sawa 0:381d475cfd6c 13
sawa 1:bd80d3e8f3a3 14 // standard interval time for XBus servo
sawa 1:bd80d3e8f3a3 15 #define kXBusStandardInterval 14 // mSec
sawa 0:381d475cfd6c 16
sawa 1:bd80d3e8f3a3 17 // angle data for XBus servo
sawa 1:bd80d3e8f3a3 18 #define kXbusServoMinimum 0x1249 // 900uSec -60 or -90 degree
sawa 1:bd80d3e8f3a3 19 #define kXbusServoNeutral 0x7FFF // 1500uSec 0 degree
sawa 1:bd80d3e8f3a3 20 #define kXbusServoMaximum 0xEDB6 // 2100uSec 60 or 90 degree
sawa 1:bd80d3e8f3a3 21
sawa 1:bd80d3e8f3a3 22 // maximum number of XBus servo
sawa 0:381d475cfd6c 23 #define kXBusMaxServoNum 50
sawa 0:381d475cfd6c 24
sawa 0:381d475cfd6c 25 // XBus Get/Set/Status command order
sawa 0:381d475cfd6c 26 typedef enum {
sawa 0:381d475cfd6c 27 kXBusOrder_1_Mode = 0x01,
sawa 0:381d475cfd6c 28 kXBusOrder_1_ID = 0x03,
sawa 0:381d475cfd6c 29 kXBusOrder_2_Version = 0x04, // only for get
sawa 0:381d475cfd6c 30 kXBusOrder_2_Product = 0x05, // only for get
sawa 0:381d475cfd6c 31 kXBusOrder_1_Unsupported = 0x06, // only for status
sawa 0:381d475cfd6c 32 kXBusOrder_2_Reset = 0x07, // only for set
sawa 0:381d475cfd6c 33 kXBusOrder_2_ParamWrite = 0x08, // only for set
sawa 0:381d475cfd6c 34
sawa 0:381d475cfd6c 35 kXBusOrder_2_Reverse = 0x10,
sawa 0:381d475cfd6c 36 kXBusOrder_2_Neutral = 0x11,
sawa 0:381d475cfd6c 37 kXBusOrder_2_H_Travel = 0x12,
sawa 0:381d475cfd6c 38 kXBusOrder_2_L_Travel = 0x13,
sawa 0:381d475cfd6c 39 kXBusOrder_2_H_Limit = 0x14,
sawa 0:381d475cfd6c 40 kXBusOrder_2_L_Limit = 0x15,
sawa 0:381d475cfd6c 41 kXBusOrder_1_P_Gain = 0x16,
sawa 0:381d475cfd6c 42 kXBusOrder_1_I_Gain = 0x17,
sawa 0:381d475cfd6c 43 kXBusOrder_1_D_Gain = 0x18,
sawa 0:381d475cfd6c 44 kXBusOrder_1_DeadBand = 0x19,
sawa 0:381d475cfd6c 45 kXBusOrder_2_PowerOffset = 0x1A,
sawa 0:381d475cfd6c 46 kXBusOrder_1_AlarmLevel = 0x1B,
sawa 0:381d475cfd6c 47 kXBusOrder_2_AlarmDelay = 0x1C,
sawa 0:381d475cfd6c 48 kXBusOrder_1_Angle_180 = 0x1D,
sawa 0:381d475cfd6c 49 kXBusOrder_1_SlowStart = 0x1E,
sawa 0:381d475cfd6c 50 kXBusOrder_1_StopMode = 0x1F,
sawa 0:381d475cfd6c 51 kXBusOrder_2_CurrentPos = 0x20, // only for get
sawa 0:381d475cfd6c 52 kXBusOrder_1_CurrentPow = 0x21, // only for get
sawa 0:381d475cfd6c 53 kXBusOrder_1_SpeedLimit = 0x22,
sawa 0:381d475cfd6c 54 kXBusOrder_2_MaxInteger = 0x23,
sawa 0:381d475cfd6c 55 } XBusOrder;
sawa 0:381d475cfd6c 56
sawa 0:381d475cfd6c 57
sawa 0:381d475cfd6c 58 // XBus parameter index
sawa 0:381d475cfd6c 59 typedef enum {
sawa 0:381d475cfd6c 60 kParamIdx_Unused0 = 0x0000,
sawa 0:381d475cfd6c 61 kParamIdx_AllData_wID = 0x0001,
sawa 0:381d475cfd6c 62 kParamIdx_AllData_woID = 0x0002,
sawa 0:381d475cfd6c 63 kParamIdx_ServoID = 0x0003,
sawa 0:381d475cfd6c 64 kParamIdx_Reversed = 0x0004,
sawa 0:381d475cfd6c 65 kParamIdx_NeutralOffset = 0x0005,
sawa 0:381d475cfd6c 66 kParamIdx_TravelHigh = 0x0006,
sawa 0:381d475cfd6c 67 kParamIdx_TravelLow = 0x0007,
sawa 0:381d475cfd6c 68 kParamIdx_LimitHigh = 0x0008,
sawa 0:381d475cfd6c 69 kParamIdx_LimitLow = 0x0009,
sawa 0:381d475cfd6c 70 kParamIdx_PGainDiff = 0x000A,
sawa 0:381d475cfd6c 71 kParamIdx_IGainDiff = 0x000B,
sawa 0:381d475cfd6c 72 kParamIdx_DGainDiff = 0x000C,
sawa 0:381d475cfd6c 73 kParamIdx_DeadBandDiff = 0x000D,
sawa 0:381d475cfd6c 74 kParamIdx_PWOffsetDiff = 0x000E,
sawa 0:381d475cfd6c 75 kParamIdx_AlarmLevel = 0x000F,
sawa 0:381d475cfd6c 76 kParamIdx_AlarmDelay = 0x0010,
sawa 0:381d475cfd6c 77 kParamIdx_Angle_180 = 0x0011,
sawa 0:381d475cfd6c 78 kParamIdx_SlowStart = 0x0012,
sawa 0:381d475cfd6c 79 kParamIdx_StopMode = 0x0013,
sawa 0:381d475cfd6c 80 kParamIdx_SpeedLimit = 0x0014,
sawa 0:381d475cfd6c 81 kParamIdx_MaxIntegerDiff = 0x0015,
sawa 0:381d475cfd6c 82 } XBusParamIdx;
sawa 0:381d475cfd6c 83
sawa 0:381d475cfd6c 84
sawa 0:381d475cfd6c 85 // XBus error code
sawa 0:381d475cfd6c 86 typedef enum {
sawa 0:381d475cfd6c 87 kXBusError_NoError = 0x0000,
sawa 0:381d475cfd6c 88 kXBusError_CRCError,
sawa 0:381d475cfd6c 89 kXBusError_ServoNumOverflow,
sawa 0:381d475cfd6c 90 kXBusError_ServoNumIsZero,
sawa 0:381d475cfd6c 91 kXBusError_AddWithSameID,
sawa 0:381d475cfd6c 92 kXBusError_IDNotFound,
sawa 0:381d475cfd6c 93 kXBusError_Unsupported,
sawa 0:381d475cfd6c 94 kXBusError_OnlyForTxOnlyMode,
sawa 0:381d475cfd6c 95 kXBusError_OnlyForNormalMode,
sawa 0:381d475cfd6c 96
sawa 0:381d475cfd6c 97 kXBusError_NumOfError,
sawa 0:381d475cfd6c 98 } XBusError;
sawa 0:381d475cfd6c 99
sawa 0:381d475cfd6c 100
sawa 0:381d475cfd6c 101
sawa 2:4aca5ffce457 102 class XBusServo // : private RawSerial
sawa 0:381d475cfd6c 103 {
sawa 0:381d475cfd6c 104 public:
sawa 4:d88f498d259b 105 /** XBusServo::XBusServo
sawa 4:d88f498d259b 106 @param tx pin name for tx
sawa 4:d88f498d259b 107 @param rx pin name for rx
sawa 4:d88f498d259b 108 @param maxServoNum max number of servo that you want to connect.
sawa 4:d88f498d259b 109 (limit 50)
sawa 4:d88f498d259b 110 this does just to resetve the buffer. you need to
sawa 4:d88f498d259b 111 add XBus servo at the beginning of your sketch
sawa 2:4aca5ffce457 112
sawa 4:d88f498d259b 113 @bref Constructor
sawa 3:9a10ad81d04e 114
sawa 4:d88f498d259b 115 @note 2014/09/02 : move from Arduino lib by Sawa
sawa 4:d88f498d259b 116 */
sawa 0:381d475cfd6c 117 XBusServo(PinName tx, PinName rx, uint8_t maxServoNum);
sawa 0:381d475cfd6c 118
sawa 0:381d475cfd6c 119 public:
sawa 1:bd80d3e8f3a3 120 XBusError start();
sawa 1:bd80d3e8f3a3 121 void stop();
sawa 1:bd80d3e8f3a3 122
sawa 0:381d475cfd6c 123 XBusError addServo(uint8_t channelID, uint16_t initValue);
sawa 0:381d475cfd6c 124 XBusError removeServo(uint8_t channelID);
sawa 0:381d475cfd6c 125 XBusError setServo(uint8_t channelID, uint16_t value);
sawa 0:381d475cfd6c 126
sawa 0:381d475cfd6c 127 void sendChannelDataPacket(void);
sawa 0:381d475cfd6c 128
sawa 0:381d475cfd6c 129 XBusError setChannelID(uint8_t oldChannelID, uint8_t newChannelID);
sawa 0:381d475cfd6c 130 XBusError setCommand(uint8_t channelID, uint8_t order, int16_t* value);
sawa 0:381d475cfd6c 131 XBusError getCommand(uint8_t channelID, uint8_t order, int16_t* value);
sawa 0:381d475cfd6c 132
sawa 0:381d475cfd6c 133 XBusError setChannelID(uint8_t newChannelID);
sawa 0:381d475cfd6c 134 XBusError setCommand(uint8_t order, int16_t* value);
sawa 0:381d475cfd6c 135
sawa 0:381d475cfd6c 136
sawa 0:381d475cfd6c 137 private:
sawa 1:bd80d3e8f3a3 138 #define kRecieveBufferSize 64
sawa 1:bd80d3e8f3a3 139
sawa 1:bd80d3e8f3a3 140 RawSerial XBusPort;
sawa 1:bd80d3e8f3a3 141
sawa 0:381d475cfd6c 142 uint8_t txOnly; // 1 for TX only mode
sawa 0:381d475cfd6c 143 PinName txPin; //
sawa 0:381d475cfd6c 144 uint8_t numOfServo; // number of servos
sawa 0:381d475cfd6c 145 uint8_t maxServo; // max number of servos
sawa 0:381d475cfd6c 146 uint8_t* chPacketBuffer; // channel data packet buffer
sawa 0:381d475cfd6c 147 uint8_t* sendBuffer; // serial send buffer
sawa 0:381d475cfd6c 148 uint8_t* sendBufferPointer;
sawa 0:381d475cfd6c 149 uint8_t sendLength;
sawa 0:381d475cfd6c 150 uint8_t recieveBuffer[kRecieveBufferSize]; // serial recieve buffer
sawa 0:381d475cfd6c 151 uint8_t recieveBufferPointer;
sawa 0:381d475cfd6c 152 uint8_t dirty; //
sawa 0:381d475cfd6c 153 uint8_t serialWriteBusy; //
sawa 0:381d475cfd6c 154 volatile uint8_t modifyServosNow; //
sawa 0:381d475cfd6c 155
sawa 0:381d475cfd6c 156 uint8_t crc_table(uint8_t data, uint8_t crc);
sawa 0:381d475cfd6c 157 uint8_t crc8(uint8_t* buffer, uint8_t length);
sawa 0:381d475cfd6c 158 uint8_t getDataSize(uint8_t order);
sawa 0:381d475cfd6c 159
sawa 0:381d475cfd6c 160 void write(uint8_t* buffer, uint8_t length);
sawa 0:381d475cfd6c 161 void flush(void);
sawa 0:381d475cfd6c 162 void TxIrqHandler(void);
sawa 0:381d475cfd6c 163 void RxIrqHandler(void);
sawa 0:381d475cfd6c 164
sawa 0:381d475cfd6c 165 XBusError sendCommandDataPacket(uint8_t command, uint8_t channelID, uint8_t order, int16_t* value, uint8_t valueSize);
sawa 0:381d475cfd6c 166 };
sawa 0:381d475cfd6c 167
sawa 0:381d475cfd6c 168
sawa 0:381d475cfd6c 169 #endif // of XBusServo_h
sawa 0:381d475cfd6c 170