Update model docs for device components

This commit is contained in:
jeremystretch
2022-08-15 11:57:38 -04:00
parent d4f976ac8d
commit f76ce172e0
20 changed files with 432 additions and 60 deletions

View File

@@ -1,8 +1,40 @@
## Power Ports
# Power Ports
A power port represents the inlet of a device where it draws its power, i.e. the connection port(s) on a device's power supply. Each power port may be assigned a physical type, as well as allocated and maximum draw values (in watts). These values can be used to calculate the overall utilization of an upstream power feed.
A power port is a device component which draws power from some external source (e.g. an upstream [power outlet](./poweroutlet.md)), and generally represents a power supply internal to a device.
## Fields
### Device
The device to which this power port belongs.
### Module
The installed module within the assigned device to which this power port belongs (optional).
### Name
The name of the power port. Must be unique to the parent device.
### Label
An alternative physical label identifying the power port.
### Type
The type of power port.
### Maximum Draw
The maximum amount of power this port consumes (in watts).
!!! info
When creating a power port on a device which supplies power to downstream devices, the allocated and maximum draw numbers should be left blank. Utilization will be calculated by taking the sum of all power ports of devices connected downstream.
When creating a power port on a device which is mapped to outlets and supplies power to downstream devices, the maximum and allocated draw numbers should be left blank. Utilization will be calculated by taking the sum of all power ports of devices connected downstream.
Cables can connect power ports only to power outlets or power feeds. (Pass-through ports cannot be used to model power distribution.)
### Allocated Draw
The budgeted amount of power this port consumes (in watts).
### Mark Connected
If selected, this component will be treated as if a cable has been connected.