SRA Board Components
ESP-IDF component for SRA Board
Public Attributes | List of all members
motor_t Struct Reference

#include <mcpwm_interface.h>

Public Attributes

esp_err_t(* enable )(motor_t *motor)
 Enable motor. More...
 
esp_err_t(* disable )(motor_t *motor)
 Disable motor. More...
 
esp_err_t(* set_speed )(motor_t *motor, uint32_t speed)
 Set motor speed. More...
 
esp_err_t(* forward )(motor_t *motor)
 Set direction of motor to forward. More...
 
esp_err_t(* backwards )(motor_t *motor)
 Set direction of motor to backwards. More...
 
esp_err_t(* brake )(motor_t *motor)
 Brake motor. More...
 
esp_err_t(* del )(motor_t *motor)
 Delete motor object. More...
 

Member Data Documentation

◆ backwards

esp_err_t(* motor_t::backwards) (motor_t *motor)

Set direction of motor to backwards.

Parameters
motorMotor object
Returns
  • ESP_OK: Success
  • ESP_ERR_INVALID_ARG: Invalid argument
  • ESP_FAIL: Failed

◆ brake

esp_err_t(* motor_t::brake) (motor_t *motor)

Brake motor.

Parameters
motorMotor object
Returns
  • ESP_OK: Success
  • ESP_ERR_INVALID_ARG: Invalid argument
  • ESP_FAIL: Failed

◆ del

esp_err_t(* motor_t::del) (motor_t *motor)

Delete motor object.

Parameters
motorMotor object
Returns
  • ESP_OK: Success
  • ESP_ERR_INVALID_ARG: Invalid argument

ESP_FAIL: Failed

◆ disable

esp_err_t(* motor_t::disable) (motor_t *motor)

Disable motor.

Parameters
motorMotor object
Returns
  • ESP_OK: Success
  • ESP_ERR_INVALID_ARG: Invalid argument

ESP_FAIL: Failed

◆ enable

esp_err_t(* motor_t::enable) (motor_t *motor)

Enable motor.

Parameters
motor_handle_tMotor object handle
Returns
  • ESP_OK: Success
  • ESP_ERR_INVALID_ARG: Invalid argument

ESP_FAIL: Failed

◆ forward

esp_err_t(* motor_t::forward) (motor_t *motor)

Set direction of motor to forward.

Parameters
motorMotor object
Returns
  • ESP_OK: Success
  • ESP_ERR_INVALID_ARG: Invalid argument

ESP_FAIL: Failed

◆ set_speed

esp_err_t(* motor_t::set_speed) (motor_t *motor, uint32_t speed)

Set motor speed.

Parameters
motorMotor object
speedSpeed of motor, 0~100
Returns
  • ESP_OK: Success
  • ESP_ERR_INVALID_ARG: Invalid argument

ESP_FAIL: Failed


The documentation for this struct was generated from the following file: