ProScript .NET Documentation
ProScript .NET Documentation
ProScript
Device Class
Device Methods
Device Fields

# Device Class

This class represents a physical ScripTouch device.
Inheritance Hierarchy
System
Object
ProScript
Device

Namespace: ProScript
Assembly: proscript-csharp (in proscript-csharp.dll) Version: 1.6.39.0 (1.6.39.0)
Syntax
C#
VB
C++
F#
Copy

    public sealed class Device

    Public NotInheritable Class Device

    public ref class Device sealed

    [<SealedAttribute>]
    type Device =  class end

The Device type exposes the following members.

Methods

| Name | Description
--- | --- | ---
| AsicReset | This method performs either a hard or soft reset of the ASIC.
| Calibrate | This method puts the device into calibration mode.
| CancelCalibrate | This method causes a calibration in progress to be canceled.
| ClearLastError | This method clears the last error that was set.
| ClearScreen | This method clears the device's screen.
| Close | This method attempts to close the device with the operating system.
| CreatePenCoordinate | This method simulates putting or moving the pen, or picking the pen up. This is used for testing.
| DeleteDeviceRegion | This method deletes a region from the device
| DeleteRegion | Obsolete. This method deletes a region from the device
| DeleteResource | This method deletes a resource from the device
| DeleteScreen | This method deletes a screen from the device
| DrawText | This method draws text on the screen (if equipped).
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
| GetActiveScreen | This method attempts to get the active screen's index.
| GetAsicRegister | This method attempts to get the asic register values from the device.
| GetCalibrationData | This method attempts to get the calibration data from the device.
| GetCalibrationState | This method attempts to get the calibration state from the device.
| GetCapabilities | Gets the capabilities of this device.
| GetConfiguration | This method attempts to get the configuration from a ScripTouch mouse device. This is not supported on all ScripTouch devices.
| GetContactCountMaximum | This method attempts to get the maximum number of contacts a ScripTouch multi-touch device supports. This is not supported on all ScripTouch devices.
| GetCoordinateRange | Gets the logical coordinate range for this device.
| GetDefaultRegions | Obsolete. This method attempts to get the default regions stored in a device that will be restored on a power cycle or reset.
| GetDeviceRegion | This method attempts to retrieve a region based off the region index.
| GetDeviceStatus | This method attempts to get the device's status
| GetDisplayInfo | Gets the static display information from the device.
| GetDisplaySettings | Gets the dynamic display settings from the device. Not supported on devices without displays.
| GetErrorCorrectionTable | This method attempts to get the error correction table from the device.
| GetFrequencyAmplitude | This method attempts to get the frequency amplitude from the device.
| GetGeneralParameters | This method attempts to get the general operating parameters from the device.
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.)
| GetManufacturer | Gets the manufacturer of the device.
| GetModel | Gets the model of the device
| GetOperatingModes | This method attempts to get the supported operating modes from the device.
| GetOutputConfiguration | This method attempts to get the output configuration from the device.
| GetPath | Gets the path of the device. Different per operating system. May change if the device is unplugged and plugged back in.
| GetPenParameters | This method attempts to get the pen parameters from the device.
| GetPeripheralConfiguration | This method attempts to get the peripheral configuration from the device.
| GetPixels | This method gets pixels starting at x,y and continuing to the end of the raster and then to the next rasters until either n pixels has been reached or the end of the image is reached.
| GetPowerState | This method attempts to get the power state from the device.
| GetProductId | Gets the product id associated with this device.
| GetRegionIndex | This method attempts to get the region index.
| GetRegions | Obsolete. Gets the currently configured regions stored in the device.
| GetResource | This method gets the information of a resource on the device based off the resource index.
| GetResourceAvailability | This method attempts to get the available space left on the device for resources.
| GetResourceIndex | This method returns the index of a resource on the signature pad based off the resource index.
| GetResourceInfo | This method attempts to get resource info from the device based off the index.
| GetScreen | This method attempts to get a screen based on the screen index.
| GetScreenIndex | This method attempts to get the screen index.
| GetScreenRegionInfo | This method attempts to get the device capabilities when it comes to regions and screens.
| GetSerialNumber | This method attempts to get the serial number from the device. This may not be supported on all devices, it may also return empty on some devices.
| GetTextHeight | Gets the height of a string using the built-in font
| GetTextWidth | Gets the width of a string using the built-in font
| GetTouchParameters | This method attempts to get the touch parameters from the device.
| GetType | Gets the type of the current instance. (Inherited from Object.)
| GetUuid | This method retrieves the universally unique identifier for this device from the device. This requires that the device be open.
| GetVendorId | gets the vendor id associated with this device
| GetVersionInfo | Gets the version information about the firmware for this device.
| IsButtonDown | Gets whether or not a button is currently being pressed.
| IsOpen | Gets whether or not this device is currently open.
| ModifyScreen | This method edits a screen using screen modify.
| Open | This method attempts to open the device with the operating system.
| Read | This method attempts to read from the device. The method will block until data is read or it is interrupted. Read data will be passed into the callbacks registered with registerInputListener().
| RegisterInputListener | This method registers an input listener for this device that will be notified of any new input.
| RestoreDefaultRegions | This method restores the regions to the defaults in flash, not necessarily the factory defaults.
| SaveRegions | Obsolete. This method will either discard region edits or save region edits persistently.
| SaveScreensRegions | This method will either discard screen and region edits or save screen and region edits persistently.
| SetActiveScreen | This method sets the active screen number.
| SetAsicRegister | This method sets an ASIC register.
| SetCalibrationData | This method sets the calibration data back to the device.
| SetDeviceConfiguration | This method sets the ScripTouch mouse configuration if supported.
| SetDeviceRegion | This method writes a region back to the device. This is used for firmware versions 4.0 and above.
| SetDisplaySettings | This method sets the dynamic display settings if supported.
| SetEasyscriptMode | Attempts to put the device in easyscript mode.
| SetErrorCorrectionTable | This method sets the error correction table in the device.
| SetFrequencyAmplitude | This method sets the frequency and amplitude of the ASIC.
| SetGeneralParameters | This method sets the general parameters of the device.
| SetLegacyFirmwareMode | This method sets the c library into legacy firmware mode (or not)
| SetOutputConfiguration | This method sets the output configuration in the device.
| SetPenParameters | This method sets the pen parameters in the device.
| SetPeripheralConfiguration | This method sets the peripheral configuration in the device.
| SetPowerState | This method sets the power state of the device.
| SetPrimaryRegion | Obsolete. This method sets the primary region of the device.
| SetProscriptMode | Attempts to put the device in proscript mode.
| SetRegion | Obsolete. This method writes a region back to the device.
| SetRegionIndex | This method sets the region index.
| SetResource | This method sets the resource data onto the device
| SetResourceIndex | This method sets the screen index for use with scriptel_get_resource and scriptel_get_resource_info. This is used for firmware versions 4.0 and above.
| SetRunMode | This method sets the device's current run mode.
| SetScreen | This method sets a screen on the device.
| SetScreenIndex | This method sets the screen index.
| SetSerialNumber | This method sets the device's serial number if supported.
| SetStartupMode | This method sets the startup mode of the device.
| SetTouchParameters | This method sets the touch parameters in the device.
| ToString | Converts this object into a human readable string. (Overrides Object ToString .)
| UnregisterInputListener | This method unregisters an input listener from this device.
| UpdateFirmwareFromFw(Stream) | This method attempts to update firmware on the device from a Scriptel firmware stream. All new firmware is provided in this format which provides a certain amount of protection against using the wrong firmware.
| UpdateFirmwareFromFw(Stream, IFirmwareListener) | This method attempts to update firmware on the device from a Scriptel firmware stream. All new firmware is provided in this format which provides a certain amount of protection against using the wrong firmware.
| UpdateFirmwareFromMot(Stream) | This method attempts to update firmware on the device from a Motorola SRECord stream. Legacy firmware is provided as MOT's. This should absolutely be avoided for new development as the MOT format has no protections in place to avoid writing the wrong firmware to a device which would render your device inoperable. Use this with extreme caution.
| UpdateFirmwareFromMot(Stream, IFirmwareListener) | This method attempts to update firmware on the device from a Motorola SRECord file. Legacy firmware is provided as MOT's. This should absolutely be avoided for new development as the MOT format has no protections in place to avoid writing the wrong firmware to a device which would render your device inoperable. Use this with extreme caution.
| UpdateRegion | Obsolete. This method updates specific region information.
| WriteDisplayChunk | This method writes a raw raster to the display of the device.
| WriteImage | This function allows you to draw a buffered image on to the screen of the device (if supported). The image must fit within the device's display boundaries. Images will be automatically converted to the displays color depth.

Top
Fields

| Name | Description
--- | --- | ---
| PowerStateNormal | Constant for the normal power state.
| PowerStatePowerDown | Constant for the power down power state.
| PowerStateStandby | Constant for the standby power state.
| RunModeAutoTouch | Constant for the auto touch run mode (not supported by all devices).
| RunModeCommand | Constant for the command run mode.
| RunModePen | Constant for the pen run mode.
| RunModePenContinuous | Constant for the pen continuous run mode (reserved for later use).
| RunModePenSingle | Constant for the pen single run mode (reserved for later use).
| RunModePenStream | Constant for the pen stream run mode (reserved for later use).
| RunModeTouch | Constant for the touch run mode (not supported by all devices).
| RunModeTouchSingle | Constant for the touch single run mode (reserved for later use).
| RunModeTouchStream | Constant for the touch stream run mode (reserved for later use).
| TextAlignCenter | Constant for aligning text anchors to the center of the text body.
| TextAlignLeft | Constant for aligning text anchors to the left of the text body.
| TextAlignRight | Constant for aligning text anchors to the right of the text body.

Top
See Also

#### Reference

ProScript Namespace

Copyright 2015 Scriptel Corporation. All Rights Reserved.