TiPWM

java.lang.Object
- tijos.framework.devicecenter.TiPWM

```
public class TiPWM
extends Object
```
The TiPWM for devicecenter of framework.

Author:

Andy.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CAPTURE_CUMULATIVE` Input capture cumulative
`static int`	`CAPTURE_INSTANTANEOUS` Input capture instantaneous
`static int`	`CAPTURE_STOP` Input capture stop
`static int`	`INPUT_BOTHEDGE` Input both edge mode
`static int`	`INPUT_FALLING` Input falling edge mode
`static int`	`INPUT_RISING` Input rising edge mode
`static int`	`OUTPUT` Output mode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`captureFreqAndDuty(int capture)` Capture frequency and duty
`void`	`close()` Close the port of current object
`double`	`getDutyCycle(int channelID)` Gets the duty cycle NOTE1: if the mode is OUTPUT, this is the duty cycle of the output pulse NOTE2: if the mode is INPUT, this is the duty cycle of the capture pulse
`int`	`getFrequency()` Gets the frequency NOTE1: if the mode is OUTPUT, this is the frequency of the output pulse NOTE2: if the mode is INPUT, this is the frequency of the capture pulse
`int`	`getPort()` Gets the port id of current object
`static TiPWM`	`open(int portID, int... channelIDs)` Open the TiPWM port by port id and the channel list, and return the object NOTE: remapID is 0, that is default location
`static TiPWM`	`openRemap(int portID, int remapID, int... channelIDs)` Open the TiPWM port by port id, remap id and the channel list, and return the object
`static int`	`portNumber()` Maximum number of port supported
`void`	`setDutyCycle(int channelID, double duty)` Set the duty cycle NOTE: only for OUTPUT mode, this is the duty cycle of the output pulse The above settings will not take effect until `updateFreqAndDuty` is called
`void`	`setFrequency(int freqValue)` Set the frequency NOTE: only for OUTPUT mode, this is the frequency of the output pulse The above settings will not take effect until `updateFreqAndDuty` is called
`void`	`setNStateParameters(boolean enable, int deadTime, boolean brake)` Set the NState(that is complementary) parameters
`void`	`setWorkMode(int channelID, int mode)` Set the channel work mode
`void`	`updateFreqAndDuty()` Update frequency and duty

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CAPTURE_CUMULATIVE
```
public static final int CAPTURE_CUMULATIVE
```
    Input capture cumulative
    
    See Also:
    
    Constant Field Values
  - CAPTURE_INSTANTANEOUS
```
public static final int CAPTURE_INSTANTANEOUS
```
    Input capture instantaneous
    
    See Also:
    
    Constant Field Values
  - CAPTURE_STOP
```
public static final int CAPTURE_STOP
```
    Input capture stop
    
    See Also:
    
    Constant Field Values
  - INPUT_BOTHEDGE
```
public static final int INPUT_BOTHEDGE
```
    Input both edge mode
    
    See Also:
    
    Constant Field Values
  - INPUT_FALLING
```
public static final int INPUT_FALLING
```
    Input falling edge mode
    
    See Also:
    
    Constant Field Values
  - INPUT_RISING
```
public static final int INPUT_RISING
```
    Input rising edge mode
    
    See Also:
    
    Constant Field Values
  - OUTPUT
```
public static final int OUTPUT
```
    Output mode
    
    See Also:
    
    Constant Field Values
- Method Detail
  - captureFreqAndDuty
```
public void captureFreqAndDuty(int capture)
                        throws IOException
```
    Capture frequency and duty
    
    Parameters:
    
    capture - capture control code,
    CAPTURE_STOP: stop capture
    CAPTURE_INSTANTANEOUS: instantaneous capture
    CAPTURE_CUMULATIVE: cumulative capture
    
    Throws:
    
    IOException - If a TiPWM error occurs
  - close
```
public void close()
           throws IOException
```
    Close the port of current object
    
    Throws:
    
    IOException - If a TiPWM error occurs
  - getDutyCycle
```
public double getDutyCycle(int channelID)
                    throws IOException
```
    Gets the duty cycle
    NOTE1: if the mode is OUTPUT, this is the duty cycle of the output pulse
    NOTE2: if the mode is INPUT, this is the duty cycle of the capture pulse
    
    Parameters:
    
    channelID - channel id
    
    Returns:
    
    duty cycle, range:0-1, that is 0% - 100%
    
    Throws:
    
    IOException - If a TiPWM error occurs
  - getFrequency
```
public int getFrequency()
                 throws IOException
```
    Gets the frequency
    NOTE1: if the mode is OUTPUT, this is the frequency of the output pulse
    NOTE2: if the mode is INPUT, this is the frequency of the capture pulse
    
    Returns:
    
    frequency value
    
    Throws:
    
    IOException - If a TiPWM error occurs
  - getPort
```
public int getPort()
```
    Gets the port id of current object
    
    Returns:
    
    the port id
  - open
```
public static TiPWM open(int portID,
                         int... channelIDs)
                  throws IOException
```
    Open the TiPWM port by port id and the channel list, and return the object
    NOTE: remapID is 0, that is default location
    
    Parameters:
    
    portID - port id
    
    channelIDs - channel id use, id range:0-15
    
    Returns:
    
    TiPWM object
    
    Throws:
    
    IOException - If a TiPWM error occurs
  - openRemap
```
public static TiPWM openRemap(int portID,
                              int remapID,
                              int... channelIDs)
                       throws IOException
```
    Open the TiPWM port by port id, remap id and the channel list, and return the object
    
    Parameters:
    
    portID - port id
    
    remapID - the remap Id, range:0-3
    
    channelIDs - channel id use, id range:0-15
    
    Returns:
    
    TiPWM object
    
    Throws:
    
    IOException - If a TiPWM error occurs
  - portNumber
```
public static int portNumber()
```
    Maximum number of port supported
    
    Returns:
    
    number
  - setDutyCycle
```
public void setDutyCycle(int channelID,
                         double duty)
                  throws IOException
```
    Set the duty cycle
    NOTE: only for OUTPUT mode, this is the duty cycle of the output pulse
    The above settings will not take effect until updateFreqAndDuty is called
    
    Parameters:
    
    channelID - the channel
    
    duty - duty cycle, range:0-1, that is 0% - 100%
    
    Throws:
    
    IOException - If a TiPWM error occurs
  - setFrequency
```
public void setFrequency(int freqValue)
                  throws IOException
```
    Set the frequency
    NOTE: only for OUTPUT mode, this is the frequency of the output pulse
    The above settings will not take effect until updateFreqAndDuty is called
    
    Parameters:
    
    freqValue - frequency, unit:Hz
    
    Throws:
    
    IOException - If a TiPWM error occurs
  - setNStateParameters
```
public void setNStateParameters(boolean enable,
                                int deadTime,
                                boolean brake)
                         throws IOException
```
    Set the NState(that is complementary) parameters
    
    Parameters:
    
    enable - enable or not, false:default
    
    deadTime - dead time, unit:ns
    
    brake - enable or not
    
    Throws:
    
    IOException - If a TiPWM error occurs
  - setWorkMode
```
public void setWorkMode(int channelID,
                        int mode)
                 throws IOException
```
    Set the channel work mode
    
    Parameters:
    
    channelID - the channel id, range:0-15
    
    mode - work mode,
    OUTPUT: Pulse output mode, default
    INPUT_RISING: Pulse rising edge input capture
    INPUT_FALLING: Pulse falling edge input capture
    INPUT_BOTHEDGE: Pulse both edge input capture
    
    Throws:
    
    IOException - If a TiPWM error occurs
  - updateFreqAndDuty
```
public void updateFreqAndDuty()
                       throws IOException
```
    Update frequency and duty
    
    Throws:
    
    IOException - If a TiPWM error occurs

Class TiPWM

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CAPTURE_CUMULATIVE

CAPTURE_INSTANTANEOUS

CAPTURE_STOP

INPUT_BOTHEDGE

INPUT_FALLING

INPUT_RISING

OUTPUT

Method Detail

captureFreqAndDuty

close

getDutyCycle

getFrequency

getPort

open

openRemap

portNumber

setDutyCycle

setFrequency

setNStateParameters

setWorkMode

updateFreqAndDuty