Description
This SmartPower Tcl command sets the battery capacity in SmartPower. The battery capacity is used to compute the battery life of your design.
smartpower_battery_settings [-capacity {decimal value}]
Arguments
| Parameter | Type | Description |
|---|
| capacity | decimal | Specify the battery capacity in mA*Hours. Value must be a positive decimal. This parameter is mandatory. |
| Return Type | Description |
|---|
| None | None |
Error Codes
| Error Code | Description |
|---|
| None | capacity: Invalid argument value: 'value' (expecting decimal value). |
| None | Parameter 'capacity' has illegal value. |
| None | Parameter 'param_name' is not defined. Valid command formatting is 'smartpower_battery_settings [-capacity "decimal value"]'. |
Supported Families
| PolarFire® |
| SmartFusion® 2 |
| RTG4™ |
| IGLOO® 2 |
| PolarFire SoC |
Example
This example sets the battery capacity to 1800 mA * Hours.
smartpower_battery_settings -capacity {1800}
