Cobranet control
[Mixer and Controls]

A cobranet adapter has one cobranet control for each cobranet interface (usually only one). More...

Functions
HPI_ERR	HPI_Cobranet_HmiWrite (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 dwHmiAddress, HW32 dwByteCount, HW8 *pbData)
	Write to an HMI variable.
HPI_ERR	HPI_Cobranet_HmiRead (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 dwHmiAddress, HW32 dwMaxByteCount, HW32 *pdwByteCount, HW8 *pbData)
	Read from an HMI variable.
HPI_ERR	HPI_Cobranet_HmiGetStatus (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 *pdwStatus, HW32 *pdwReadableSize, HW32 *pdwWriteableSize)
	Get the status of the last cobranet operation.
HPI_ERR	HPI_Cobranet_GetIPaddress (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 *pdwIPaddress)
	Get the CobraNet node's current IP address.
HPI_ERR	HPI_Cobranet_SetIPaddress (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 dwIPaddress)
	Set the CobraNet node's current IP address.
HPI_ERR	HPI_Cobranet_GetStaticIPaddress (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 *pdwIPaddress)
	Get the CobraNet node's static IP address.
HPI_ERR	HPI_Cobranet_SetStaticIPaddress (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 dwIPaddress)
	Set the CobraNet node's static IP address.
HPI_ERR	HPI_Cobranet_GetMACaddress (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 *pdwMAC_MSBs, HW32 *pdwMAC_LSBs)
	Get the CobraNet node's MAC address.

---

Detailed Description

A cobranet adapter has one cobranet control for each cobranet interface (usually only one).

The cobranet control is located on (HPI_SOURCENODE_COBRANET,0,HPI_DESTNODE_COBRANET,0) The cobranet control allows reading and writing of the cobranet HMI variables (See Cirrus cobranet documentation @ www.cobranet.info for details)

---

Function Documentation

HPI_ERR HPI_Cobranet_HmiWrite (  HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW32  dwHmiAddress, HW32  dwByteCount, HW8 *  pbData )

Write to an HMI variable. Returns: 0 on success, or one of the HPI Error codes. Return values: HPI_ERROR_INVALID_CONTROL  if type is not cobranet HPI_ERROR_INVALID_OPERATION  if HMI variable is not writeable HPI_ERROR_INVALID_DATASIZE  if requested size is greater than the HMI variable size Parameters: phSubSys  Subsystem handle hControl  Handle of a Cobranet control dwHmiAddress  dwHmiAddress HMI address dwByteCount  Number of bytes to send to the control pbData  pointer to data to send

HPI_ERR HPI_Cobranet_HmiRead (  HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW32  dwHmiAddress, HW32  dwMaxByteCount, HW32 *  pdwByteCount, HW8 *  pbData )

Read from an HMI variable. Returns: 0 on success, or one of the HPI Error codes. Return values: HPI_ERROR_INVALID_CONTROL  if type is not cobranet The amount of data returned will be the minimum of the input dwMaxByteCount and the actual size of the variable reported by the HMI Parameters: phSubSys  Subsystem handle hControl  Handle of a cobranet control dwHmiAddress  HMI address dwMaxByteCount  maximum number of bytes to return (<= buffer size of pbData) pdwByteCount  actual number of bytes returned pbData  data read from HMI variable

HPI_ERR HPI_Cobranet_HmiGetStatus (  HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW32 *  pdwStatus, HW32 *  pdwReadableSize, HW32 *  pdwWriteableSize )

Get the status of the last cobranet operation. Returns: 0 on success, or one of the HPI Error codes. Parameters: phSubSys  Subsystem handle hControl  Handle of a cobranet control pdwStatus  the raw status word from the HMI pdwReadableSize  the reported readable size from the last variable access pdwWriteableSize  the reported writeable size from the last variable access

HPI_ERR HPI_Cobranet_GetIPaddress (  HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW32 *  pdwIPaddress )

Get the CobraNet node's current IP address. Allows the user to get the current IP address of the CobraNet node. Returns: 0 on success, or one of the HPI Error codes. 0 on success, or one of the HPI Error codes Return values: HPI_ERROR_INVALID_CONTROL  if type is not cobranet Parameters: phSubSys  Subsystem handle hControl  Handle of a cobranet control pdwIPaddress  the current IP address

HPI_ERR HPI_Cobranet_SetIPaddress (  HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW32  dwIPaddress )

Set the CobraNet node's current IP address. Allows the user to set the current IP address of the CobraNet node. Returns: 0 on success, or one of the HPI Error codes. Return values: HPI_ERROR_INVALID_CONTROL  if type is not cobranet Parameters: phSubSys  Subsystem handle hControl  Handle of a cobranet control dwIPaddress  the new current IP address

HPI_ERR HPI_Cobranet_GetStaticIPaddress (  HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW32 *  pdwIPaddress )

Get the CobraNet node's static IP address. Returns: 0 on success, or one of the HPI Error codes. Return values: HPI_ERROR_INVALID_CONTROL  if type is not cobranet Allows the user to get the static IP address of the CobraNet node. Parameters: phSubSys  Subsystem handle hControl  Handle of a cobranet control pdwIPaddress  the static IP address

HPI_ERR HPI_Cobranet_SetStaticIPaddress (  HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW32  dwIPaddress )

Set the CobraNet node's static IP address. Returns: 0 on success, or one of the HPI Error codes. Return values: HPI_ERROR_INVALID_CONTROL  if type is not cobranet Allows the user to set the static IP address of the CobraNet node. Parameters: phSubSys  Subsystem handle hControl  Handle of a cobranet control dwIPaddress  the new static IP address

HPI_ERR HPI_Cobranet_GetMACaddress (  HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW32 *  pdwMAC_MSBs, HW32 *  pdwMAC_LSBs )

Get the CobraNet node's MAC address. Returns: 0 on success, or one of the HPI Error codes. Return values: HPI_ERROR_INVALID_CONTROL  if type is not cobranet Allows the user to get the MAC address of the CobraNet node. Parameters: phSubSys  Subsystem handle hControl  Handle of a cobranet control pdwMAC_MSBs  the first 4 bytes of the MAC address. pdwMAC_LSBs  the last 2 bytes of the MAC address returned in the upper 2 bytes.

---