Add i2c joystick 2 esphome component#59
Open
ItsRebaseTime wants to merge 1 commit intom5stack:mainfrom
Open
Conversation
Contributor
|
Hi @ItsRebaseTime, Thanks for your contribution! We'll run some test and review/merge as soon as we can. |
Comment on lines
+17
to
+19
| void I2CJoystick2Component::setup() { | ||
| ESP_LOGCONFIG(TAG, "Setting up I2C Joystick2..."); | ||
| } |
Contributor
There was a problem hiding this comment.
logging in setup shouldn't use ESP_LOGCONFIG
Suggested change
| void I2CJoystick2Component::setup() { | |
| ESP_LOGCONFIG(TAG, "Setting up I2C Joystick2..."); | |
| } | |
| void I2CJoystick2Component::setup() { | |
| ESP_LOGD(TAG, "Setting up I2C Joystick2..."); | |
| } |
Comment on lines
+118
to
+126
| ESP_LOGCONFIG(TAG, "I2C Joystick2:"); | ||
| LOG_I2C_DEVICE(this); | ||
|
|
||
| if (this->is_failed()) { | ||
| ESP_LOGE(TAG, "Communication with Joystick2 failed"); | ||
| return; | ||
| } | ||
|
|
||
| ESP_LOGCONFIG(TAG, " Firmware version: %u", this->firmware_version_); |
Contributor
There was a problem hiding this comment.
when use ESP_LOGCONFIG, it would be nice to merge the information together, following Logging Best Practices.
Suggested change
| ESP_LOGCONFIG(TAG, "I2C Joystick2:"); | |
| LOG_I2C_DEVICE(this); | |
| if (this->is_failed()) { | |
| ESP_LOGE(TAG, "Communication with Joystick2 failed"); | |
| return; | |
| } | |
| ESP_LOGCONFIG(TAG, " Firmware version: %u", this->firmware_version_); | |
| if (this->is_failed()) { | |
| ESP_LOGE(TAG, "Communication with Joystick2 failed"); | |
| return; | |
| } | |
| ESP_LOGCONFIG(TAG, "I2C Joystick2: \n" | |
| " Firmware version: %u", | |
| this->firmware_version_); | |
| LOG_I2C_DEVICE(this); |
Comment on lines
+147
to
+148
| ESP_LOGCONFIG(TAG, " Axis: %s", this->axis_ == AXIS_X ? "X" : "Y"); | ||
| ESP_LOGCONFIG(TAG, " Mode: %u", this->mode_); |
Contributor
There was a problem hiding this comment.
merge these two together
Suggested change
| ESP_LOGCONFIG(TAG, " Axis: %s", this->axis_ == AXIS_X ? "X" : "Y"); | |
| ESP_LOGCONFIG(TAG, " Mode: %u", this->mode_); | |
| ESP_LOGCONFIG(TAG, " Axis: %s\n" | |
| " Mode: %u", | |
| this->axis_ == AXIS_X ? "X" : "Y" | |
| this->mode_); |
Comment on lines
+12
to
+22
| AXIS_OPTIONS = { | ||
| "x": 0, | ||
| "y": 1, | ||
| } | ||
|
|
||
| MODE_OPTIONS = { | ||
| "adc_16bit": 0, | ||
| "adc_8bit": 1, | ||
| "offset_12bit": 2, | ||
| "offset_8bit": 3, | ||
| } |
Contributor
There was a problem hiding this comment.
probably shoud use code gen to create enum, as it can map the enum defined in C/C++:
enum Axis : uint8_t {
AXIS_X = 0,
AXIS_Y = 1,
};
enum OutputMode : uint8_t {
MODE_ADC_16BIT = 0,
MODE_ADC_8BIT = 1,
MODE_OFFSET_12BIT = 2,
MODE_OFFSET_8BIT = 3,
};
And to use the enum provided by ESPHome:
JoyStick2Axis = i2c_joystick_2_ns.enum("Axis")
JoyStick2Modes = i2c_joystick_2_ns.enum("OutputMode")
Suggested change
| AXIS_OPTIONS = { | |
| "x": 0, | |
| "y": 1, | |
| } | |
| MODE_OPTIONS = { | |
| "adc_16bit": 0, | |
| "adc_8bit": 1, | |
| "offset_12bit": 2, | |
| "offset_8bit": 3, | |
| } | |
| AXIS_OPTIONS = { | |
| "X": JoyStick2Axis.AXIS_X, | |
| "Y": JoyStick2Axis.AXIS_Y, | |
| } | |
| MODE_OPTIONS = { | |
| "ADC_16BIT": JoyStick2Modes.MODE_ADC_16BIT, | |
| "ADC_8BIT": JoyStick2Modes.MODE_ADC_8BIT, | |
| "OFFSET_12BIT": JoyStick2Modes.MODE_OFFSET_12BIT, | |
| "OFFSET_8BIT": JoyStick2Modes.MODE_OFFSET_8BIT, | |
| } |
Comment on lines
+33
to
+34
| cv.Optional(CONF_AXIS, default="x"): cv.one_of(*AXIS_OPTIONS.keys(), lower=True), | ||
| cv.Optional(CONF_MODE, default="offset_12bit"): cv.one_of(*MODE_OPTIONS.keys(), lower=True), |
Contributor
There was a problem hiding this comment.
instead use cv.one_of(), we can use cv.enum()
Suggested change
| cv.Optional(CONF_AXIS, default="x"): cv.one_of(*AXIS_OPTIONS.keys(), lower=True), | |
| cv.Optional(CONF_MODE, default="offset_12bit"): cv.one_of(*MODE_OPTIONS.keys(), lower=True), | |
| cv.Optional(CONF_AXIS, default="x"): cv.enum(JoyStick2Axis), | |
| cv.Optional(CONF_MODE, default="offset_12bit"): cv.enum(JoyStick2Modes), |
Contributor
parker-int64
left a comment
parker-int64
left a comment
There was a problem hiding this comment.
Great work on this PR! The overall structure looks solid and the implementation is clear.
We just have a few minor suggestions that could help improve readability/robustness:
- The logging style, we recommend following the best practice provided by ESPHome
- The enum definations, use internal API to make it more concise.
Nothing major — once these are addressed, this should be good to go 🚀.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.