API Reference v9.2.0
Unitsenum
Represents all units available across the library.
Native
| Constant | Unit |
|---|---|
Units.native | Device native units |
Length
| Constant | Unit |
|---|---|
Units.lengthMetres | Metres |
Units.Length.m | Metres |
Units.lengthCentimetres | Centimetres |
Units.Length.cm | Centimetres |
Units.lengthMillimetres | Millimetres |
Units.Length.mm | Millimetres |
Units.lengthMicrometres | Micrometres |
Units.Length.µm | Micrometres |
Units.Length.um | Micrometres |
Units.lengthNanometres | Nanometres |
Units.Length.nm | Nanometres |
Units.lengthInches | Inches |
Units.Length.in | Inches |
Velocity
| Constant | Unit |
|---|---|
Units.velocityMetresPerSecond | Metres per second |
Units.velocity["m/s"]! | Metres per second |
Units.velocityCentimetresPerSecond | Centimetres per second |
Units.velocity["cm/s"]! | Centimetres per second |
Units.velocityMillimetresPerSecond | Millimetres per second |
Units.velocity["mm/s"]! | Millimetres per second |
Units.velocityMicrometresPerSecond | Micrometres per second |
Units.velocity["µm/s"]! | Micrometres per second |
Units.velocity["um/s"]! | Micrometres per second |
Units.velocityNanometresPerSecond | Nanometres per second |
Units.velocity["nm/s"]! | Nanometres per second |
Units.velocityInchesPerSecond | Inches per second |
Units.velocity["in/s"]! | Inches per second |
Acceleration
| Constant | Unit |
|---|---|
Units.accelerationMetresPerSecondSquared | Metres per second squared |
Units.acceleration["m/s²"]! | Metres per second squared |
Units.acceleration["m/s^2"]! | Metres per second squared |
Units.accelerationCentimetresPerSecondSquared | Centimetres per second squared |
Units.acceleration["cm/s²"]! | Centimetres per second squared |
Units.acceleration["cm/s^2"]! | Centimetres per second squared |
Units.accelerationMillimetresPerSecondSquared | Millimetres per second squared |
Units.acceleration["mm/s²"]! | Millimetres per second squared |
Units.acceleration["mm/s^2"]! | Millimetres per second squared |
Units.accelerationMicrometresPerSecondSquared | Micrometres per second squared |
Units.acceleration["µm/s²"]! | Micrometres per second squared |
Units.acceleration["um/s^2"]! | Micrometres per second squared |
Units.accelerationNanometresPerSecondSquared | Nanometres per second squared |
Units.acceleration["nm/s²"]! | Nanometres per second squared |
Units.acceleration["nm/s^2"]! | Nanometres per second squared |
Units.accelerationInchesPerSecondSquared | Inches per second squared |
Units.acceleration["in/s²"]! | Inches per second squared |
Units.acceleration["in/s^2"]! | Inches per second squared |
Angle
| Constant | Unit |
|---|---|
Units.angleDegrees | Degrees |
Units.angle["°"]! | Degrees |
Units.angle["deg"]! | Degrees |
Units.angleRadians | Radians |
Units.angle["rad"]! | Radians |
Angular Velocity
| Constant | Unit |
|---|---|
Units.angularVelocityDegreesPerSecond | Degrees per second |
Units.angularVelocity["°/s"]! | Degrees per second |
Units.angularVelocity["deg/s"]! | Degrees per second |
Units.angularVelocityRadiansPerSecond | Radians per second |
Units.angularVelocity["rad/s"]! | Radians per second |
Angular Acceleration
| Constant | Unit |
|---|---|
Units.angularAccelerationDegreesPerSecondSquared | Degrees per second squared |
Units.angularAcceleration["°/s²"]! | Degrees per second squared |
Units.angularAcceleration["deg/s^2"]! | Degrees per second squared |
Units.angularAccelerationRadiansPerSecondSquared | Radians per second squared |
Units.angularAcceleration["r/s²"]! | Radians per second squared |
Units.angularAcceleration["r/s^2"]! | Radians per second squared |
Units.angularAcceleration["rad/s²"]! | Radians per second squared |
Units.angularAcceleration["rad/s^2"]! | Radians per second squared |
AC Electric Current
| Constant | Unit |
|---|---|
Units.aCElectricCurrentAmperesPeak | Amperes peak |
Units.aCElectricCurrent["A(peak)"]! | Amperes peak |
Units.aCElectricCurrentAmperesRms | Amperes RMS |
Units.aCElectricCurrent["A(RMS)"]! | Amperes RMS |
Percent
| Constant | Unit |
|---|---|
Units.percentPercent | Percent |
Units.percent["%"]! | Percent |
DC Electric Current
| Constant | Unit |
|---|---|
Units.dCElectricCurrentAmperes | Amperes |
Units.DCElectricCurrent.A | Amperes |
Force
| Constant | Unit |
|---|---|
Units.forceNewtons | Newtons |
Units.Force.N | Newtons |
Units.forceMillinewtons | Millinewtons |
Units.Force.mN | Millinewtons |
Units.forcePoundsForce | Pounds-force |
Units.Force.lbf | Pounds-force |
Units.forceKilonewtons | Kilonewtons |
Units.Force.kN | Kilonewtons |
Time
| Constant | Unit |
|---|---|
Units.timeSeconds | Seconds |
Units.Time.s | Seconds |
Units.timeMilliseconds | Milliseconds |
Units.Time.ms | Milliseconds |
Units.timeMicroseconds | Microseconds |
Units.Time.µs | Microseconds |
Units.Time.us | Microseconds |
Torque
| Constant | Unit |
|---|---|
Units.torqueNewtonMetres | Newton metres |
Units.torque["N⋅m"]! | Newton metres |
Units.torqueNewtonCentimetres | Newton centimetres |
Units.torque["N⋅cm"]! | Newton centimetres |
Units.torquePoundForceFeet | Pound-force-feet |
Units.torque["lbf⋅ft"]! | Pound-force-feet |
Units.torqueOunceForceInches | Ounce-force-inches |
Units.torque["ozf⋅in"]! | Ounce-force-inches |
Inertia
| Constant | Unit |
|---|---|
Units.inertiaGrams | Grams |
Units.Inertia.g | Grams |
Units.inertiaKilograms | Kilograms |
Units.Inertia.kg | Kilograms |
Units.inertiaMilligrams | Milligrams |
Units.Inertia.mg | Milligrams |
Units.inertiaPounds | Pounds |
Units.Inertia.lb | Pounds |
Units.inertiaOunces | Ounces |
Units.Inertia.oz | Ounces |
Rotational Inertia
| Constant | Unit |
|---|---|
Units.rotationalInertiaGramSquareMetre | Gram-square metre |
Units.rotationalInertia["g⋅m²"]! | Gram-square metre |
Units.rotationalInertia["g⋅m^2"]! | Gram-square metre |
Units.rotationalInertiaKilogramSquareMetre | Kilogram-square metre |
Units.rotationalInertia["kg⋅m²"]! | Kilogram-square metre |
Units.rotationalInertia["kg⋅m^2"]! | Kilogram-square metre |
Units.rotationalInertiaPoundSquareFeet | Pound-square-feet |
Units.rotationalInertia["lb⋅ft²"]! | Pound-square-feet |
Units.rotationalInertia["lb⋅ft^2"]! | Pound-square-feet |
Units.rotationalInertiaGramSquareMillimetre | Gram-square millimetre |
Units.rotationalInertia["g⋅mm²"]! | Gram-square millimetre |
Units.rotationalInertia["g⋅mm^2"]! | Gram-square millimetre |
Force Constant
| Constant | Unit |
|---|---|
Units.forceConstantNewtonsPerAmp | Newtons per amp |
Units.forceConstant["N/A"]! | Newtons per amp |
Units.forceConstantMillinewtonsPerAmp | Millinewtons per amp |
Units.forceConstant["mN/A"]! | Millinewtons per amp |
Units.forceConstantKilonewtonsPerAmp | Kilonewtons per amp |
Units.forceConstant["kN/A"]! | Kilonewtons per amp |
Units.forceConstantPoundsForcePerAmp | Pounds-force per amp |
Units.forceConstant["lbf/A"]! | Pounds-force per amp |
Torque Constant
| Constant | Unit |
|---|---|
Units.torqueConstantNewtonMetresPerAmp | Newton metres per amp |
Units.torqueConstant["N⋅m/A"]! | Newton metres per amp |
Units.torqueConstantMillinewtonMetresPerAmp | Millinewton metres per amp |
Units.torqueConstant["mN⋅m/A"]! | Millinewton metres per amp |
Units.torqueConstantKilonewtonMetresPerAmp | Kilonewton metres per amp |
Units.torqueConstant["kN⋅m/A"]! | Kilonewton metres per amp |
Units.torqueConstantPoundForceFeetPerAmp | Pound-force-feet per amp |
Units.torqueConstant["lbf⋅ft/A"]! | Pound-force-feet per amp |
Voltage
| Constant | Unit |
|---|---|
Units.voltageVolts | Volts |
Units.Voltage.V | Volts |
Units.voltageMillivolts | Millivolts |
Units.Voltage.mV | Millivolts |
Units.voltageMicrovolts | Microvolts |
Units.Voltage.µV | Microvolts |
Units.Voltage.uV | Microvolts |
Current Controller Proportional Gain
| Constant | Unit |
|---|---|
Units.currentControllerProportionalGainVoltsPerAmp | Volts per amp |
Units.currentControllerProportionalGain["V/A"]! | Volts per amp |
Units.currentControllerProportionalGainMillivoltsPerAmp | Millivolts per amp |
Units.currentControllerProportionalGain["mV/A"]! | Millivolts per amp |
Units.currentControllerProportionalGainMicrovoltsPerAmp | Microvolts per amp |
Units.currentControllerProportionalGain["µV/A"]! | Microvolts per amp |
Units.currentControllerProportionalGain["uV/A"]! | Microvolts per amp |
Current Controller Integral Gain
| Constant | Unit |
|---|---|
Units.currentControllerIntegralGainVoltsPerAmpPerSecond | Volts per amp per second |
Units.currentControllerIntegralGain["V/(A⋅s)"]! | Volts per amp per second |
Units.currentControllerIntegralGainMillivoltsPerAmpPerSecond | Millivolts per amp per second |
Units.currentControllerIntegralGain["mV/(A⋅s)"]! | Millivolts per amp per second |
Units.currentControllerIntegralGainMicrovoltsPerAmpPerSecond | Microvolts per amp per second |
Units.currentControllerIntegralGain["µV/(A⋅s)"]! | Microvolts per amp per second |
Units.currentControllerIntegralGain["uV/(A⋅s)"]! | Microvolts per amp per second |
Current Controller Derivative Gain
| Constant | Unit |
|---|---|
Units.currentControllerDerivativeGainVoltsSecondPerAmp | Volts second per amp |
Units.currentControllerDerivativeGain["V⋅s/A"]! | Volts second per amp |
Units.currentControllerDerivativeGainMillivoltsSecondPerAmp | Millivolts second per amp |
Units.currentControllerDerivativeGain["mV⋅s/A"]! | Millivolts second per amp |
Units.currentControllerDerivativeGainMicrovoltsSecondPerAmp | Microvolts second per amp |
Units.currentControllerDerivativeGain["µV⋅s/A"]! | Microvolts second per amp |
Units.currentControllerDerivativeGain["uV⋅s/A"]! | Microvolts second per amp |
Resistance
| Constant | Unit |
|---|---|
Units.resistanceKiloohms | Kiloohms |
Units.Resistance.kΩ | Kiloohms |
Units.resistanceOhms | Ohms |
Units.Resistance.Ω | Ohms |
Units.resistanceMilliohms | Milliohms |
Units.Resistance.mΩ | Milliohms |
Units.resistanceMicroohms | Microohms |
Units.Resistance.µΩ | Microohms |
Units.Resistance.uΩ | Microohms |
Units.resistanceNanoohms | Nanoohms |
Units.Resistance.nΩ | Nanoohms |
Inductance
| Constant | Unit |
|---|---|
Units.inductanceHenries | Henries |
Units.Inductance.H | Henries |
Units.inductanceMillihenries | Millihenries |
Units.Inductance.mH | Millihenries |
Units.inductanceMicrohenries | Microhenries |
Units.Inductance.µH | Microhenries |
Units.Inductance.uH | Microhenries |
Units.inductanceNanohenries | Nanohenries |
Units.Inductance.nH | Nanohenries |
Voltage Constant
| Constant | Unit |
|---|---|
Units.voltageConstantVoltSecondsPerRadian | Volt seconds per radian |
Units.voltageConstant["V·s/rad"]! | Volt seconds per radian |
Units.voltageConstantMillivoltSecondsPerRadian | Millivolt seconds per radian |
Units.voltageConstant["mV·s/rad"]! | Millivolt seconds per radian |
Units.voltageConstantMicrovoltSecondsPerRadian | Microvolt seconds per radian |
Units.voltageConstant["µV·s/rad"]! | Microvolt seconds per radian |
Units.voltageConstant["uV·s/rad"]! | Microvolt seconds per radian |
Absolute Temperature
| Constant | Unit |
|---|---|
Units.absoluteTemperatureDegreesCelsius | Degrees Celsius |
Units.absoluteTemperature["°C"]! | Degrees Celsius |
Units.absoluteTemperature["degC"]! | Degrees Celsius |
Units.absoluteTemperatureKelvins | Kelvins |
Units.absoluteTemperature["K"]! | Kelvins |
Units.absoluteTemperatureDegreesFahrenheit | Degrees Fahrenheit |
Units.absoluteTemperature["°F"]! | Degrees Fahrenheit |
Units.absoluteTemperature["degF"]! | Degrees Fahrenheit |
Units.absoluteTemperatureDegreesRankine | Degrees Rankine |
Units.absoluteTemperature["°R"]! | Degrees Rankine |
Units.absoluteTemperature["degR"]! | Degrees Rankine |
Relative Temperature
| Constant | Unit |
|---|---|
Units.relativeTemperatureDegreesCelsius | Degrees Celsius |
Units.relativeTemperature["°C"]! | Degrees Celsius |
Units.relativeTemperature["degC"]! | Degrees Celsius |
Units.relativeTemperatureKelvins | Kelvins |
Units.relativeTemperature["K"]! | Kelvins |
Units.relativeTemperatureDegreesFahrenheit | Degrees Fahrenheit |
Units.relativeTemperature["°F"]! | Degrees Fahrenheit |
Units.relativeTemperature["degF"]! | Degrees Fahrenheit |
Units.relativeTemperatureDegreesRankine | Degrees Rankine |
Units.relativeTemperature["°R"]! | Degrees Rankine |
Units.relativeTemperature["degR"]! | Degrees Rankine |
Frequency
| Constant | Unit |
|---|---|
Units.frequencyGigahertz | Gigahertz |
Units.Frequency.GHz | Gigahertz |
Units.frequencyMegahertz | Megahertz |
Units.Frequency.MHz | Megahertz |
Units.frequencyKilohertz | Kilohertz |
Units.Frequency.kHz | Kilohertz |
Units.frequencyHertz | Hertz |
Units.Frequency.Hz | Hertz |
Units.frequencyMillihertz | Millihertz |
Units.Frequency.mHz | Millihertz |
Units.frequencyMicrohertz | Microhertz |
Units.Frequency.µHz | Microhertz |
Units.Frequency.uHz | Microhertz |
Units.frequencyNanohertz | Nanohertz |
Units.Frequency.nHz | Nanohertz |