termux-api-library

termux-api-library

Termux-API library for NodeJS

install

• Make sure you've first installed the termux and termux-api on your Android device from the f-droid or github releases.

• • termux - f-droid | github releases
• • termux-api - f-droid | github releases

• To use Termux:API you also need to install the termux-api package.

pkg install termux-api

• Finally get this node library

npm i --save termux-api-library

Example usage

library import

const api = require('termux-api-library');

or 

import api from 'termux-api-library';

• isTermux Check if the device is Android (termux)

const isTermux = api.isTermux // return is true or false

if (isTermux) {

    await api.termux_wifi_connectioninfo((e) => {
        console.log(e);
    });

}

• isTermuxApi check if termux-api is installed on your Android

await api.isTermuxApi((e) => {
    console.log(e); // return is true or false
});

or

const isTermuxApi = await api.isTermuxApi();
console.log(isTermuxApi); // return is true or false

• termux-battery-status

Get the status of the device battery.

await api.termux_battery_status((e) => {

console.log(e);

});

• termux-brightness

Set the screen brightness between 0 and 255.

await api.termux_brightness(255);

• termux-call-log

List call log history.

await api.termux_call_log(10, (e) => {

console.log(e);

})

• termux-camera-info

Get information about device camera(s).

await api.termux_camera_info((e) => {

console.log(e);

})

• termux-camera-photo

Take a photo and save it to a file in JPEG format.

await api.termux_camera_photo(0, './test.jpeg');

• termux-clipboard-get

Get the system clipboard text.

await api.termux_clipboard_get((e) => {

console.log(e);

})

• termux-clipboard-set

Set the system clipboard text.

await api.termux_clipboard_set("hello world")

• termux-contact-list

List all contacts.

await api.termux_contact_list((e) => {

console.log(e);

})

• termux-dialog

Show a text entry dialog.

const hint = 'Put your password here'

const title = 'input password'

await api.termux_dialog(hint, title, false, true, true, (e) => {

console.log(e);

})

• termux-download

Download a files

const url = 'https://example.com/image.jpeg'

const filename = 'photo_2022'

const savePath = '/data/data/com.termux/files/home'

await api.termux_download(url, filename, savePath);

• termux-fingerprint

Use fingerprint sensor on device to check for authentication.

await api.termux_fingerprint((e) => {

console.log(e);

})

• termux-location

Get the device location.

await api.termux_location("gps", "once", (e) => {

console.log(e);

})

or

const data = await api.termux_location('gps', 'once')

console.log(data);

• termux-media-player

Play media files.

const info = await api.termux_media_player.info();

console.log(info);

const play = await api.termux_media_player.play();

console.log(play);

const playFile = await api.termux_media_player.playFile(path);

console.log(playFile);

const pause = await api.termux_media_player.pause();

console.log(pause);

const stop = await api.termux_media_player.stop();

console.log(stop);

• termux-microphone-record

Recording using microphone on your device.

const info = await api.termux_microphone_record.info();

console.log(info);

const path = '/data/data/com.termux/files/home/filename.mp3'

const limit = 0

const start = await api.termux_microphone_record.start(path, limit);

console.log(start);

const stop = await api.termux_microphone_record.stop();

console.log(stop);

• termux-notification Display a system notification.

await api.termux_notification(title, text, id);

• termux-notification-remove Remove a notification previously shown with termux-notification --id.

await api.termux_notification_remove(id);

• termux-sensor Get information about types of sensors as well as live data.

await api.termux_sensor((e) => {
    console.log(e);
});

or

const sensor = await api.termux_sensor();
console.log(sensor);

• termux-share Share a file specified as argument received on stdin.

const filepath = "../image.jpeg"
await api.termux_share('send', filepath);

• termux-sms-list List SMS messages.

const type = "inbox"
const limit = 10
const sender = undefined || "all" // the number for locate message : To display all senders, type the "all" or don't assign a value to the variable

await api.termux_sms_list(type, limit, sender, (e) => {
    console.log(e);
});

or

const list = await api.termux_sms_list(type, limit, sender);
console.log(list);

• termux-sms-send Send a SMS message to the specified recipient number(s).

const number = 05592xxxxx
const slot = "0"
const text = "hello world"
await api.termux_sms_send(number, slot, text);

• termux-telephony-call Call a telephony number.

// connect
const number = 05592xxxxx
await api.termux_telephony_call.connect(number);

// Close call .

await api.termux_telephony_call.close();

• termux-telephony-cellinfo Get information about all observed cell information from all radios on the device including the primary and neighboring cells.

const info = await api.termux_telephony_cellinfo();
console.log(info);

• termux-telephony-deviceinfo Get information about the telephony device.

const deviceinfo = await api.termux_telephony_deviceinfo();
console.log(deviceinfo);

• termux-toast Show text in a Toast (a transient popup).

const position = "middle"
const background = "gray"
const text_color = "white"
const text = "hello world"
await api.termux_toast(position, background, text_color, text);

• termux-torch Toggle LED Torch on device.

const values = "on" // on - enable torch. | off - disable torch.
await api.termux_torch(values);

• termux-wifi-connectioninfo Print information about current Wi-Fi connection. This information include: SSID (AP name), BSSID (AP mac address), device IP and other.

await api.termux_wifi_connectioninfo((e) => {
    console.log(e);
});

or  

const wifi = await api.termux_wifi_connectioninfo();
console.log(wifi);

• termux-wifi-enable Toggles Wi-Fi on/off.

const values = true // true - enable Wi-Fi | false - disable Wi-Fi
await api.termux_wifi_enable(values);

• termux-wifi-scaninfo Retrieves last wifi scan information.

await api.termux_wifi_scaninfo((e) => {
    console.log(e);
});

or  

const scaninfo = await api.termux_wifi_scaninfo();
console.log(scaninfo);

License

MIT license