public class CoreCANcoder : ParentDevice
type CoreCANcoder =
class
inherit ParentDevice
end
CoreCANcoder | Constructs a new CANcoder object. |
Configurator | The configurator for this device. Users may use this to refresh and apply configs, such as the CANcoderConfiguration object |
ControlRequest |
The last applied control request.
Caller can cast this to the derived class if they know what type it is,
otherwise they can use the ControlInfo to get info out of it.
(Inherited from ParentDevice) |
DeviceHash |
Hash of this device
(Inherited from ParentDevice) |
DeviceID |
ID of this device
(Inherited from ParentDevice) |
HasResetOccurred | Returns true if device has reset since the previous call of this routine. |
Network |
Network this device is on
(Inherited from ParentDevice) |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
GetAbsolutePosition |
Absolute Position of device. The possible range is documented
below, however the exact expected range is determined by the
AbsoluteSensorRange.
|
GetFault_BadMagnet |
The magnet distance is not correct or magnet is missing
|
GetFault_BootDuringEnable |
Device boot while detecting the enable signal
|
GetFault_Hardware |
Hardware fault occurred
|
GetFault_Undervoltage |
Device supply voltage dropped to near brownout levels
|
GetFault_UnlicensedFeatureInUse |
An unlicensed feature is in use, device may not behave as
expected.
|
GetFaultField |
Integer representing all faults
This returns the fault flags reported by the device. These are
device specific and are not used directly in typical applications.
Use the signal specific GetFault_*() methods instead.
|
GetHashCode | Serves as the default hash function. (Inherited from Object) |
GetMagnetHealth |
Magnet health as measured by CANcoder.
Magnet health as measured by CANcoder. Red indicates too close or
too far, Orange is adequate but with reduced accuracy, green is
ideal. Invalid means the accuracy cannot be determined.
Default Rates:
|
GetPosition |
Position of device.
|
GetPositionSinceBoot |
The relative position reported by the CANcoder since boot.
This is the total displacement reported by CANcoder since power
up. This signal is relative and is not influenced by the fusing
algorithm. It is also not timesynced. If you wish to use a signal
with timesync, use Position.
|
GetResetOccurredChecker | Return a lambda that checks for device resets |
GetStickyFault_BadMagnet |
The magnet distance is not correct or magnet is missing
|
GetStickyFault_BootDuringEnable |
Device boot while detecting the enable signal
|
GetStickyFault_Hardware |
Hardware fault occurred
|
GetStickyFault_Undervoltage |
Device supply voltage dropped to near brownout levels
|
GetStickyFault_UnlicensedFeatureInUse |
An unlicensed feature is in use, device may not behave as
expected.
|
GetStickyFaultField |
Integer representing all sticky faults
This returns the persistent "sticky" fault flags reported by the
device. These are device specific and are not used directly in
typical applications. Use the signal specific GetStickyFault_*()
methods instead.
|
GetSupplyVoltage |
Measured supply voltage to the CANcoder.
|
GetType | Gets the Type of the current instance. (Inherited from Object) |
GetUnfilteredVelocity |
The unfiltered velocity reported by CANcoder.
This is the unfiltered velocity reported by CANcoder. This signal
does not use the fusing algorithm. It is also not timesynced. If
you wish to use a signal with timesync, use Velocity.
|
GetVelocity |
Velocity of device.
|
GetVersion |
Full Version. The format is a four byte value.
Full Version of firmware in device. The format is a four byte
value.
|
GetVersionBugfix |
App Bugfix Version number.
|
GetVersionBuild |
App Build Version number.
|
GetVersionMajor |
App Major Version number.
|
GetVersionMinor |
App Minor Version number.
|
LookupStatusSignalT(UInt16, String, Boolean) |
Looks up a status signal and inserts it into the local dictionary
if not found
(Inherited from ParentDevice) |
LookupStatusSignalT(UInt16, Int32, FuncDictionaryInt32, StatusSignalT, String, Boolean) |
Looks up a status signal and inserts it into the local dictionary
if not found
(Inherited from ParentDevice) |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
OptimizeBusUtilization |
Optimizes the device's bus utilization by reducing the update frequencies of its status signals.
All status signals that have not been explicitly given an update frequency will be
disabled. Note that if other status signals in the same status frame have been given
an update frequency, the update frequency will be honored for the entire frame.
This function only needs to be called once on this device in the robot program. Additionally, this
method does not necessarily need to be called after setting the update frequencies of other signals.
To restore the default status update frequencies, remove this method call, redeploy the robot
application, and power-cycle the devices on the bus. Alternatively, the user can override
individual status update frequencies using {@link BaseStatusSignal#setUpdateFrequency}.
(Inherited from ParentDevice) |
ReportIfTooOld |
Function to call to check if the device is
too old, and if so report it to the console output
(Overrides ParentDeviceReportIfTooOld) |
SetControl | Control motor with generic control request object. User must make sure the specified object is castable to a valid control request, otherwise this function will fail at run-time and return the NotSupported StatusCode |
SetControlPrivate |
Sets the control request to this device
(Inherited from ParentDevice) |
ToString | Returns a string that represents the current object. (Inherited from Object) |
deviceIdentifier |
The unique deviceIdentifier for this device
(Inherited from ParentDevice) |