navKeys

Navigation key control module for Android device interaction in the Total Control scripting system.

This module allows scripted directional navigation and screen scrolling actions on a connected device.
All functions are injected into Device.prototype, enabling direct use via device.up(), device.down(), etc.

It includes both basic directional actions (e.g., up, down) and accelerated versions (e.g., shiftUp, shiftPgDn)
for quicker movement. The module is useful for UI traversal, automated page scrolling, and script-driven navigation.

Features

  • Move the screen or focus slightly in all directions: up, down, left, right
  • Move faster or across larger sections with shiftUp, shiftDown, shiftPgUp, etc.
  • Scroll full pages with pgUp, pgDn
  • Uniform return value (0) on success
  • All functions are available as methods on device

Example Usage

var navKeys = require("sigma/navKeys");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (sigmaDevice) {
    device.pgDown();       // Scroll one page down
    device.shiftRight();   // Quickly move right
    device.up();           // Move slightly upward
}

(inner) down() → {number}

The device screen page moves down a little.
"shiftDown" moves faster and larger than "down".

Example
// Example:
var navKeys = require("sigma/navKeys");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (!sigmaDevice) {
    print("No device found");
} else {
    sigmaDevice.down();
}

// Operation Result:
return 0
Returns:
number

Returns 0 if the operation succeeds.

(inner) left() → {number}

The device screen page moves left a little.
"shiftLeft" moves faster and larger than "left".

Example
// Example:
var navKeys = require("sigma/navKeys");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (!sigmaDevice) {
    print("No device found");
} else {
    sigmaDevice.left();
}

// Operation Result:
return 0
Returns:
number

Returns 0 if the operation succeeds.

(inner) pgDn() → {number}

The device screen page moves right a little.
"shiftPgDn" moves faster and larger than "pgDn".

Example
// Example:
var navKeys = require("sigma/navKeys");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (!sigmaDevice) {
    print("No device found");
} else {
    sigmaDevice.pgDn();
}

// Operation Result:
return 0
Returns:
number

Returns 0 if the operation succeeds.

(inner) pgUp() → {number}

Device screen page moves up one screen.
"shiftPgUp" moves faster and larger than "pgUp".

Example
// Example:
var navKeys = require("sigma/navKeys");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (!sigmaDevice) {
    print("No device found");
} else {
    sigmaDevice.pgUp();
}

// Operation Result:
return 0
Returns:
number

Returns 0 if the operation succeeds.

(inner) right() → {number}

The device screen page moves right a little.
"shiftRight" moves faster and larger than "right".

Example
// Example:
var navKeys = require("sigma/navKeys");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (!sigmaDevice) {
    print("No device found");
} else {
    sigmaDevice.right();
}

// Operation Result:
return 0
Returns:
number

Returns 0 if the operation succeeds.

(inner) shiftDown() → {number}

The device screen page moves down a little.
"shiftDown" moves faster and larger than "down".

Example
// Example:
var navKeys = require("sigma/navKeys");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (!sigmaDevice) {
    print("No device found");
} else {
    sigmaDevice.shiftDown();
}

// Operation Result:
return 0
Returns:
number

Returns 0 if the operation succeeds.

(inner) shiftLeft() → {number}

The device screen page moves left a little.
"shiftLeft" moves faster and larger than "left".

Example
// Example:
var navKeys = require("sigma/navKeys");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (!sigmaDevice) {
    print("No device found");
} else {
    sigmaDevice.shiftLeft();
}

// Operation Result:
return 0
Returns:
number

Returns 0 if the operation succeeds.

(inner) shiftPgDn() → {number}

The device screen page moves right a little.
"shiftPgDn" moves faster and larger than "pgDn".

Example
// Example:
var navKeys = require("sigma/navKeys");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (!sigmaDevice) {
    print("No device found");
} else {
    sigmaDevice.shiftPgDn();
}

// Operation Result:
return 0
Returns:
number

Returns 0 if the operation succeeds.

(inner) shiftPgUp() → {number}

Device screen page moves up one screen.
"shiftPgUp" moves faster and larger than "pgUp".

Example
// Example:
var navKeys = require("sigma/navKeys");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (!sigmaDevice) {
    print("No device found");
} else {
    sigmaDevice.shiftPgUp();
}

// Operation Result:
return 0
Returns:
number

Returns 0 if the operation succeeds.

(inner) shiftRight() → {number}

The device screen page moves right a little.
"shiftRight" moves faster and larger than "right".

Example
// Example:
var navKeys = require("sigma/navKeys");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (!sigmaDevice) {
    print("No device found");
} else {
    sigmaDevice.shiftRight();
}

// Operation Result:
return 0
Returns:
number

Returns 0 if the operation succeeds.

(inner) shiftUp() → {number}

The device screen page moves up a little.
"shiftUp" moves faster and larger than "up".

Example
// Example:
var navKeys = require("sigma/navKeys");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (!sigmaDevice) {
    print("No device found");
} else {
    sigmaDevice.shiftUp();
}

// Operation Result:
return 0
Returns:
number

Returns 0 if the operation succeeds.

(inner) up() → {number}

The device screen page moves up a little.
"shiftUp" moves faster and larger than "up".

Example
// Example:
var navKeys = require("sigma/navKeys");
var { Device } = require('sigma/device');
var sigmaDevice = Device.getMain();
if (!sigmaDevice) {
    print("No device found");
} else {
    sigmaDevice.up();
}

// Operation Result:
return 0
Returns:
number

Returns 0 if the operation succeeds.