|
FireSync API
|
Represents configuration for a node's local encoder.
Public Member Functions | |
| kStatus | kEncoder_ClearAll (kEncoder encoder) |
| Resets encoder device settings to defaults. More... | |
| kEncoderDirection | kEncoder_Direction (kEncoder encoder) |
| Gets the current interpretation of encoder A/B signals to yield forward/reverse direction. More... | |
| kStatus | kEncoder_DirectionInfo (kEncoder encoder, kInfoBits *info) |
| Reports constraint and validity information for the Direction setting. More... | |
| kStatus | kEncoder_Enable (kEncoder encoder, kBool enable) |
| Enables or disables the encoder. More... | |
| kStatus | kEncoder_EnableIndexReset (kEncoder encoder, kBool enabled) |
| Enables reset-on-index. More... | |
| kStatus | kEncoder_EnableSimulation (kEncoder encoder, kBool enabled) |
| Enables encoder simulation. More... | |
| kBool | kEncoder_IndexResetEnabled (kEncoder encoder) |
| Reports whether reset-on-index is enabled. More... | |
| kStatus | kEncoder_IndexResetEnabledInfo (kEncoder encoder, kInfoBool *info) |
| Reports constraint and validity information for the IndexResetEnabled setting. More... | |
| kBool | kEncoder_IsEnabled (kEncoder encoder) |
| Reports whether the encoder is currently enabled. More... | |
| kStatus | kEncoder_Reset (kEncoder encoder) |
| Resets the counter of this encoder module. More... | |
| kStatus | kEncoder_SetDirection (kEncoder encoder, kEncoderDirection direction) |
| Sets the current interpretation of encoder A/B signals to yield forward/reverse direction. More... | |
| kStatus | kEncoder_SetSimulationDirection (kEncoder encoder, kBool direction) |
| Sets the encoder simulation direction. More... | |
| kStatus | kEncoder_SetSimulationPeriod (kEncoder encoder, k64u period) |
| Sets the simulation period, in nanoseconds. More... | |
| kStatus | kEncoder_SetSimulationResolution (kEncoder encoder, k32u resolution) |
| Sets the simulation resolution. More... | |
| kStatus | kEncoder_SetSnapshotSource (kEncoder encoder, kEncoderSnapshotSource source) |
| Sets the snapshot source for an encoder. More... | |
| kStatus | kEncoder_SetSnapshotSourceId (kEncoder encoder, k32u id) |
| Sets the snapshot source id for an encoder. More... | |
| kBool | kEncoder_SimulationDirection (kEncoder encoder) |
| Reports the simulation direction. More... | |
| kStatus | kEncoder_SimulationDirectionInfo (kEncoder encoder, kInfoBool *info) |
| Reports constraint and validity information for the SimulationDirection setting. More... | |
| kBool | kEncoder_SimulationEnabled (kEncoder encoder) |
| Reports whether encoder simulation is enabled. More... | |
| kStatus | kEncoder_SimulationEnabledInfo (kEncoder encoder, kInfoBool *info) |
| Reports constraint and validity information for the SimulationEnabled setting. More... | |
| k64u | kEncoder_SimulationPeriod (kEncoder encoder) |
| Gets the simulation period, in nanoseconds. More... | |
| kStatus | kEncoder_SimulationPeriodInfo (kEncoder encoder, kInfo64u *info) |
| Reports constraint and validity information for the SimulationPeriod setting. More... | |
| k32u | kEncoder_SimulationResolution (kEncoder encoder) |
| Gets the simulation resolution. More... | |
| kStatus | kEncoder_SimulationResolutionInfo (kEncoder encoder, kInfo32u *info) |
| Reports constraint and validity information for the SimulationResolution setting. More... | |
| kEncoderSnapshotSource | kEncoder_SnapshotSource (kEncoder encoder) |
| Retrieves the snapshot source. More... | |
| k32u | kEncoder_SnapshotSourceId (kEncoder encoder) |
| Gets the snapshot source id for an encoder. More... | |
| kStatus | kEncoder_SnapshotSourceIdInfo (kEncoder encoder, kInfo *info) |
| Reports constraint and validity information for the SnapshotSourceId setting. More... | |
| kStatus | kEncoder_SnapshotSourceInfo (kEncoder encoder, kInfoBits *info) |
| Reports constraint and validity information for the Snapshot Source setting. More... | |
