Merge pull request #18117 from LP-HAW/fix-phydat_to_json

sys/phydat: fix phydat_to_json precondition
RIOT-OS · May 19, 2022 · bb56b34 · bb56b34
2 parents 158203f + 7a94b36
commit bb56b34
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/sys/include/phydat.h b/sys/include/phydat.h
@@ -277,11 +277,11 @@ void phydat_fit(phydat_t *dat, const int32_t *values, unsigned int dim);
  * for @ref UNIT_NONE.
  *
  * @param[in]  data     data to encode
- * @param[in]  dim      dimensions used in @p data, MUST be > 0 and < PHYDAT_DIM
+ * @param[in]  dim      dimensions used in @p data, MUST be > 0 and <= PHYDAT_DIM
  * @param[out] buf      target buffer for the JSON string, or NULL
  *
  * @pre     @p dim > 0
- * @pre     @p dim < PHYDAT_DIM
+ * @pre     @p dim <= PHYDAT_DIM
  *
  * @return  number of bytes (potentially) written to @p buf, including `\0`
  *          terminator

diff --git a/sys/phydat/phydat_json.c b/sys/phydat/phydat_json.c
@@ -43,7 +43,7 @@ static size_t _bool_to_str(int16_t val, char *buf)
 
 size_t phydat_to_json(const phydat_t *data, size_t dim, char *buf)
 {
-    assert((dim > 0) && (dim < PHYDAT_DIM));
+    assert((dim > 0) && (dim <= PHYDAT_DIM));
 
     size_t pos = 0;