adafruit / adafruit/Wippersnapper_Components

[REQ] Component Request: Support MCUs with built-in temperature sensors

Open
#111 0 comments 0 reactions 0 assignees View on GitHub
request
Dominant language
No language data
Stars
11
Forks
46
Avg merge
3d 18h
Merged PRs (30d)
2

Description

Boards utilizing a MCU with a built-in temperature sensor (measuring how hot the chip is) are identified via https://github.com/adafruit/Wippersnapper_Boards/issues/94

To expose this as a component, we'd need a new component type called `mcuTempSensor`

Proposed `schema.json`:
```
{
"title": "MCU Temperature Sensor Component Definition",
"description": "A MCU temperature sensor WipperSnapper component for use in Adafruit IO",
"type": "object",
"required": [ "displayName", "subcomponents", ],
"additionalProperties": false,
"properties": {
"displayName": {
"description": "The human-friendly name of this component.",
"type": "string",
"minLength": 3,
"maxLength": 30
},
"published": {
"description": "If true, this component is supported by the current firmware version and will be displayed to all users. If false, it is hidden behind a developer toggle so that contributors can still work on it against the production site.",
"type": "boolean"
},
"subcomponents": {
"description": "The chip's temperature sensor (and its Fahrenheit counterpart).",
"type": "array",
"items": {
"type": "string",
"pattern": "^ambient-temp(-fahrenheit)?$"
}
}
}
}
```

Depending on what MCU name is defined by the board's definition.json, the component picker would present an image of that chip (maybe we can also overlay a thermometer icon):

For example, the PicoW use the RP2040 platform and the component's image would look like:

![image](https://user-images.githubusercontent.com/322428/210089162-e7fe5a65-d170-4799-875a-f851bf1cac4b.png)

For the ESP32-S2 platform
![image](https://user-images.githubusercontent.com/322428/210089200-f146e3c7-099b-4fae-a130-2094a8ab1cb9.png)

Related:
https://github.com/adafruit/Adafruit_Wippersnapper_Arduino/issues/390
https://github.com/adafruit/Wippersnapper_Boards/issues/94

Contributor guide

No contributing guide indexed for this repository

Research direction

Begin by locating schema.json and reviewing how existing component definitions are structured. Check how MCU names from each board's definition.json are used by the component picker, and review the related Wippersnapper_Boards #94 and Adafruit_Wippersnapper_Arduino #390 issues. Done means the mcuTempSensor schema and requested MCU-specific picker images are represented.

Written by the indexing model from the issue text.

Assessment

Domain
backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.