Skip to content

hkust-smartcar/Creative18

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

95 Commits

conda

conda

 
 

docs

docs

 
 

k60

k60

 
 

openMV

openMV

 
 

ui

ui

 
 

README.md

README.md

 
 

h.path.cu

h.path.cu

 
 

hamiltonian.cpp

hamiltonian.cpp

 
 

Repository files navigation

Creative18

To have the best view of this document, download Typora, the best Markdown editor ever

Hardware Specifications

1. UART Allocation

PTE24 UART4_RX (BT) -> UiProtocol PTE25 UART4_TX (BT) -> UiProtocol

PTB10 UART3_RX (UART) -> Protocol PTB11 UART3_TX (UART) -> Protocol

PTB16 UART0_RX (GPIO1) -> OpenMV1 PTB17 UART0_TX (GPIO2) -> OpenMV1

PTD2 UART1_RX (SOUT) -> OpenMV2 PTD3 UART1_TX (SIN) -> OpenMV2

Software Specifications

I. Data Structure

A. k60

graph TD;
id1[Encoders and motors]
wheelbase-->|contains|id1
wheelbase-->|contains|protocol
wheelbase-->|contains|uiprotocol
protocol-->|contains|wheelbase
uiprotocol-->|contains|wheelbase
wheelbase-->|contains|scheduler
protocol-->|contains|bluetooth
uiprotocol-->|contains|bluetooth
scheduler-->|used by|bluetooth
bluetooth-->|extends|comm

II. Coordinate System

Global Origin at top left corner of game field, unit mm (integer), x-axis right going, y axis down going. Global rotational angle defined by x-axis to y-axis direction, in radian(float)

III. Protocol

A. Constants

//Package Anotations
HEAD = 0xAA,
END = 0xFF,

//Package Types
kACK = 0x00,
kRequestSetMotor = 0x01,
kRequestEncoder = 0x02,
kResponseEncoder = 0x03,
kRequestMove = 0x04,
kRequestSetMotorById = 0x05,
kRequestEncoderById = 0x06,
kResponseEncoderById = 0x07,
kRequestEncoders = 0x08,
kResponseEncoders = 0x09,
kFeedGlobalRotation = 0x0A,
kFeedGlobalTranslation = 0x0B,
kRequestSetServo = 0x0C,
kRequestAutoFeedEncoders = 0x0D,
kRequestAutoFeedEncodersById = 0x0E,
kFeedCorners = 0xA0,
kFeedLocalRotation = 0xA1,
kFeedLocalTranslation = 0xA2

B. Package structure

|HEAD|LENGTH|PACKAGE_TYPE|PACKAGE_ID|DATA|...|CHECKSUM|END|

where: HEAD = 0xAA

LENGTH = length of whole package including header and end

PACKAGE_TYPE = package Type, determine the function of package

PACKAGE_ID = unique id of package over a machine, for ACK packages

CHECKSUM = sum of all bytes in package mod 256

END = 0xFF

C. Communication Flow

1. Roles

Master: the tempory camera17 coard

Slave: the tempory balance17 board

Super: the UI/ OpenMV/ other high level instances...

OpenMV

Ui

2. Communication Flow

  • the sendPackageImmediate function send the package only once and will not take care the acknowledge
  • the queuePackage function will keep sending the package until corresponding acknowledgement is received. It is done by pushing the package to a queue,
  • peroid function will call sendPackageImmediate function for each package inside the queue, which should be done periodically
  • listen function will parse the incoming bytes from Rx
  • buildBufferPackage convert byte array to package
  • packageHandler is called when package is built.
    • If the package is not an acknowledgement package, it will send an acknowledgement package for that;
    • if the package is an acknowledgement package, it will remove corresponding package from queue

D. Protocol Details

1. Motor Control
Data:

int16_t motorpower (PWM)

Response:

<none>

Master -> Slave: kRequestSetMotor(Power)
Slave -> Master: kACK
Note over Slave: motor0 setpower
2. Request Encoder
Data:

<none>

Response:

int32_t encoder_count (accumunative, from kResponseEncoder Type)

Note:

if calling await version will halt the master until recieve the count

Master->Slave: kRequestEncoder
Slave->Master: kACK
Note over Slave: get encoder0 count
Slave->Master: kResponseEncoder(count)
Master->Slave: kACK
3. Move
Data:

int16_t x_speed (TBC)

int16_t y_speed (TBC)

Response:

<none>

Super->Master: kRequestMove(x,y)
Master->Super: kACK
Note over Master: Set Moter0, Motor1
Master->Slave: kRequestSetMotor(power)
Slave->Master: kACK
Note over Slave: Set Motor0
4. Set Motor By Id
Data:

uin8_t id

Return:

<none>

Super->Master: kRequestSetMotorById(id, power)
Master->Super: kACK
Note over Master: if id<2: Set Motor by id
Note over Master: if id==2: request slave
Master-->Slave: kRequestSetMotor(power)
Slave-->Master: kACK
5. Request Encoders by id
data

uint8_t id

return

int32_t count

Super->Master: kRequestEncoderById(id)
Master->Super: kACK
Note over Master: if id<2: Get Encoder
Note over Master: if id==2: Request Encoder
Master-->Slave: kRequestEncoder
Slave-->Master: kACK
Note over Slave: encoder0 get count
Slave-->Master: kResponseEncoder(count)
Master-->Slave: kACK
Master->Super: kResponseEncoderById(id, count)
Super->Master: kACK
6. Request Encoders
data:

none

response:

int32_t encoder0_count, encoder1_count, encoder2_count

Super->Master: kRequestEncoders
Master->Super: kACK
Note over Master: Encoder0,1 Get Count
Master->Slave: kRequestEncoder
Slave->Master: kACK
Note over Slave: encoder0 get count
Slave->Master: kResponseEncoder(count)
Master->Slave: kACK
Master->Super: kResponseEncoders(count0, count1, count2)
Super->Master: kACK
7. Feed Global Rotation
data

float rotation angle

uint16_t lapse (time_spent_on_calculation)

uint16_t frame_id

response

none

Note over Super: new frame
Super->Master: kFeedGlobalRotation(angle,time)
Master->Super: kACK
8. Feed Global Translation
data:

int32_t x_translation, y_translation

uint16_t lapse (time_spent_on_calculation)

uint16_t frame_id

return:

none

Note over Super: new frame
Super->Master: kFeedTranslation
Master->Super: kACK
9. Feed Corners
data:

uint16_t frame_id

uint8_t chunk_id (the buffer length should be limited below 100)

uint16_t[] x0, y0, x1, y1, ...

response:

<none>

Note over OpenMV: on frame
OpenMV -> Ui: kFeedCorners(frame_id, chunk_id ...)
OpenMV -> Ui: kFeedCorners(frame_id, chunk_id ...)
Ui -> OpenMV: kACK
Ui -> OpenMV: kACK
10. Servo Control
Data:

uint16_t servo degree (PWM)

Response:

<none>

Master -> Slave: kRequestSetServo(Degree)
Slave -> Master: kACK
Note over Slave: servo0 set degree
11. Feed Local Rotation
data

float rotation angle

uint16_t lapse (time_spent_on_calculation)

uint16_t frame_id

response

none

Note over Super: new frame
Super->Master: kFeedLocalRotation(angle,time,frame_id)
Master->Super: kACK
12. Request Auto Feed Encoders
data

uint16_t interval in ms for checking encoders, send when encoder value is changed, 0 for canceling the auto feed. If an auto feed is already started in the protocol, it will overwrite the original one

response

none

Ui->Master: kRequestAutoFeedEncoders(interval)
Master->Ui: kACK
Note over Master: (general behavior of this protocol)
Master->Slave: kRequestAutoFeedEncoders(interval)
Slave->Master: kACK
Note over Slave: For each interval encoder value changed
Slave->Master: kResponseEncoder(count)
Master->Slave: kACK

Title: general behavior
Any -> k60: kRequestAutoFeedEncoders(interval)
Note over k60: For every interval
Note over k60: If encoder[k] got changed
k60 -> Any: kResponseEncodersById(k,accunumate count)
Any->k60: kACK
Note: minimum interval depends on the setting of scheduler
13. Feed Local Translation
data:

int32_t x_translation, y_translation

uint16_t lapse (time_spent_on_calculation)

uint16_t frame_id

return:

none

Note over OpenMV: new frame
OpenMV->Ui: kFeedLocalTranslation
Ui->OpenMV: kACK
14. Request Auto Feed Encoders By Id
data:

uint8_t id

uint16_t interval in ms for checking encoders, send when encoder value is changed, 0 for canceling the auto feed. If an auto feed is already started in the protocol, it will overwrite the original one

return:

none

About

Repository For Creative Group 2018

hkust-smartcar.github.io/Creative18/

Topics

electronjs k60 openmv

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

10 watching

Forks

1 fork
Report repository

Releases 1

User Interface Latest
Jul 7, 2018

Packages

No packages published

Contributors 2

  •  
  •  

Languages