[J. Nick Koston (bdraco)]

Description

Documents put_be16(), put_be24(), put_be32(), put_le16() and put_le32() from esphome/core/helpers.h, which write an integer into an existing byte buffer and return the pointer past it, in the "Helpers for raw device data" section next to the checksum helpers.

Pull request in esphome this documents (if applicable):

• [core] Add put_be and put_le helpers to write integers into byte buffers esphome#22211

[netlify]

✅ Deploy Preview for esphome-dev-docs ready!

Name	Link
🔨 Latest commit	e0ee04a
🔍 Latest deploy log	https://app.netlify.com/projects/esphome-dev-docs/deploys/6aeb52619daffdcc65a7abc8
😎 Deploy Preview	https://deploy-preview-318--esphome-dev-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[Copilot]

🟢 Approval recommended

No active review issues are reported for the integer-to-buffer helper documentation update.

No open issues 🎉

What changed in this PR

Documents the integer-to-buffer helpers introduced in esphome/esphome#22211, adding guidance alongside the existing raw device data helpers.

Changes:

• Describes the five big- and little-endian write helpers with a before-and-after example.
• Explains pointer chaining, fixed write widths, signed values, and alignment requirements, and points to helpers for decoding bytes.

File	Description
src/​content/​docs/​contributing/​code.md	Adds a section on writing integers into existing byte buffers.

_{Review effort: Balanced}

[J. Nick Koston (bdraco)]

ESPHome Bot (@esphbot) review

[J. Nick Koston (bdraco)]

ESPHome Bot (@esphbot) review

[J. Nick Koston (bdraco)]

ESPHome Bot (@esphbot) review

[ESPHome Bot (esphbot)]

Previous review — superseded by a newer review below.

[ESPHome Bot (esphbot)]

Tip

No blocking issues found — ready to merge.

[J. Nick Koston (bdraco)]

ESPHome Bot (@esphbot) review

[ESPHome Bot (esphbot)]

PR Review — Document put_be and put_le helpers for writing integers into byte buffers

Approve: the one finding from the last review is fixed, and nothing new came up.

What works well:

• The section opens with why the helpers exist: byte order is easy to get wrong when the shifts are written by hand. This matches how the checksum section before it is framed.
• The before/after example is a realistic register-address frame, and p = put_be16(p, length); shows how the returned pointer is used.
• The fixed-width paragraph (lines 450–455) now says plainly that each helper writes the width in its name and drops any higher bits. It gives both the int-promotion case (x >> 8) and the put_be24() top-byte case. This fixes the earlier finding that the sentence only covered the 16-bit helpers.
• It covers two's complement for signed values and says the buffer does not need to be aligned.
• It points to the decode helpers (encode_uint16, encode_value<T>, encode_value_le<T>), using the names the i2c architecture docs already use.
• The section sits between Checksums and Signed values, and its heading level and style match both.

No open issues.

---

---

Checklist

• Matches PR description (documents put_be16/24/32, put_le16/32 in raw device data section)
• Prior finding (fixed-width wording) resolved
• Referenced helper names consistent with existing docs
• No hardcoded secrets

---

Automated review by Kōan (Claude) HEAD=e0ee04a 20s

[ESPHome Bot (esphbot)]

Tip

No blocking issues found — ready to merge.