> ## Documentation Index
> Fetch the complete documentation index at: https://developers.podero.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Heat Pump Attributes

> Writable parameters for configuring heat pump devices

# Heat Pump Attributes

Heat pump attributes are writable parameters that control device behavior and optimization settings.

## Required Parameters

<ParamField body="user_id" type="string (UUID)" required>
  User ID that owns this heat pump device.

  **Example:** `016b78a7-0c7c-4241-a277-015c3ad3cb90`

  **Writable:** No (set at device creation)
</ParamField>

## Device Model

<ParamField body="device_model" type="object">
  The device model assigned to this heat pump. Set during onboarding.

  **Writable:** No (set at device creation)

  <Expandable title="device_model fields">
    <ParamField body="manufacturer" type="string">
      Manufacturer name. **Example:** `Nibe`
    </ParamField>

    <ParamField body="model" type="string">
      Model name. **Example:** `S2125-8`
    </ParamField>

    <ParamField body="year" type="integer">
      Model year, if available. **Example:** `2022`
    </ParamField>

    <ParamField body="device_type" type="object">
      <Expandable title="device_type fields">
        <ParamField body="short_name" type="string">
          Machine-readable device type identifier. **Example:** `hp_atw`
        </ParamField>

        <ParamField body="long_name" type="string">
          Human-readable device type label. **Example:** `Heat Pump (Air-to-Water)`
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

## Optimization Control

<ParamField body="is_smart_optimization_active" type="boolean">
  Flag indicating whether Podero's smart optimization is actively controlling this device.

  Set to `false` to pause optimization without disconnecting the device.

  **Example:** `true`

  **Writable:** Yes
</ParamField>

<ParamField body="optimization_level" type="enum">
  The aggressiveness ceiling at which Podero optimizes this heat pump. Controls how far the system will shift the heat pump's operation to chase cheap spot price windows.

  **Options:** `Low`, `Mid`, `Max`

  **Example:** `Mid`

  **Writable:** Yes
</ParamField>

## Usage Examples

### Enable Optimization

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    'https://app.podero.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{device_id}' \
    -H 'Authorization: Bearer {auth_token}' \
    -H 'Content-Type: application/json' \
    -d '{
      "is_smart_optimization_active": true
    }'
  ```

  ```python Python theme={null}
  response = requests.put(
      f'https://app.podero.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{device_id}',
      headers={
          'Authorization': f'Bearer {auth_token}',
          'Content-Type': 'application/json'
      },
      json={
          'is_smart_optimization_active': True,
      }
  )
  ```
</CodeGroup>

## Best Practices

<AccordionGroup>
  <Accordion title="Optimization Control">
    * Keep `is_smart_optimization_active` enabled for cost savings
    * Optimization works best with spot hourly energy pricing
  </Accordion>
</AccordionGroup>

<CardGroup cols={2}>
  <Card title="Heat Pump State" icon="chart-line" href="/partner-api/reference/heat-pumps/state">
    Read-only state data and current readings
  </Card>

  <Card title="Setting Preferences" icon="sliders" href="/partner-api/user-journeys/end-user/setting-preferences">
    User workflow for configuring preferences
  </Card>

  <Card title="Device Onboarding" icon="plug" href="/partner-api/user-journeys/end-user/device-onboarding">
    Connecting heat pump devices
  </Card>
</CardGroup>