Favorites

Favorites allow users to save and manage personalized cooking presets for their SmartHQ-enabled devices, creating a convenient library of go-to recipes and cooking preferences.

Think of favorites as custom cooking profiles that users can create, name, and reuse. For example, a user might create a "Perfect Salmon" favorite for their smoker that includes their preferred temperature (225°F), smoke level (medium), cooking time (2 hours), and even personal notes about seasoning. Or they might save a "Morning Toast" favorite for their toaster oven with specific shade, slice count, and convection settings.

Favorites add convenience, consistency, and personalization to a user's SmartHQ account.

How to make use of favorites:

Favorites can be specified through the Digital Twin API endpoints. We offer CRUD (Create, Read, Update, Delete) capabilities for managing favorites. However, there are limitations for creating favorites:

Devices that Support Favorites

Currently, the only device types that support favorites are...

• Smoker (cloud.smarthq.device.smoker)
• Toaster Oven (cloud.smarthq.device.toasteroven)

What you can do:

• Create favorites for supported devices (smoker, toaster oven)
• Update existing favorites for supported devices
• Delete favorites for any supported device
• Reorder favorites for supported devices

What you can't do:

• Add support for new device types like cloud.smarthq.device.microwave
• Define custom property schemas for new devices
• Extend the favorite system to unsupported devices

As the SmartHQ Platform Team adds in new favorites capabilities, they will be updated here.

Saving a new favorite (using POST /v2/favorite)

When creating a favorite, you're essentially saving a complete cooking profile that captures all the settings needed to reproduce a specific cooking result. The request structure varies depending on the device type, as each device has its own unique cooking parameters.

The following is an explanation of the request message used in POST /v2/favorite:

Name	Value	Description
kind	string	device#favorite.
deviceType	string	The deviceType.
favorite	object	Favorite data. Object properties depend on device type.

The Smoker favorite object:

Device Type	Name	Value	Description
Smoker	name	string	(required for favorite) Name for the favorite.
Smoker	notes	string	(optional) Notes for the favorite.
Smoker	smokeLevel	integer	(required for favorite) Smoker level for the favorite.
Smoker	temperature	integer	(required for favorite) Target temperature for the favorite.
Smoker	preset	string	(required for favorite) Cook mode preset (available for smoker) for the favorite.
Smoker	keepWarm	boolean	(optional) Keep warm option for the favorite.
Smoker	isProbeMode	boolean	(required for favorite) If true probe mode, if false time mode.
Smoker	probeTemperature	integer	(required for favorite if isProbeMode is true) Probe temperature target for the favorite.
Smoker	cookTimeHours	integer	(required for favorite if isProbeMode is false) Hours for the favorite.
Smoker	cookTimeMinutes	integer	(required for favorite if isProbeMode is false) Minutes for the favorite.

The Toaster Oven favorite object:

Device Type	Name	Value	Description
Toaster Oven	name	string	(required for favorite) Name for the favorite.
Toaster Oven	mode	string	(required for favorite) Cook mode (available for toasteroven) for the favorite.
Toaster Oven	convectionFanOn	boolean	(optional) Convection fan on for the favorite.
Toaster Oven	count	integer	(optional) Count for the favorite.
Toaster Oven	preference	integer	(optional) Preference for the favorite.
Toaster Oven	size	integer	(optional) Size for the favorite.
Toaster Oven	shade	integer	(optional) Shade for the favorite.
Toaster Oven	slice	integer	(optional) Slice for the favorite
Toaster Oven	temperature	integer	(optional) Temperature for the favorite.
Toaster Oven	time	integer	(optional) Time for the favorite