Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/roccomuso/termux

Node.js module for Termux-API
https://github.com/roccomuso/termux

android api js node nodejs termux wrapper

Last synced: 5 days ago
JSON representation

Node.js module for Termux-API

Awesome Lists containing this project

README 

        
# termux



[![NPM Version](https://img.shields.io/npm/v/termux.svg)](https://www.npmjs.com/package/termux)

[![Dependency Status](https://david-dm.org/roccomuso/termux.png)](https://david-dm.org/roccomuso/termux)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)



> Comprehensive Node.js module for [Termux-API](https://wiki.termux.com/wiki/Termux:API)



## Install



1. Make sure you've first installed the [termux-api](https://play.google.com/store/apps/details?id=com.termux.api) on your Android device from the Play store.

2. Then install the scripts with `apt install termux-api`.

3. Finally get this node module:



    $ `npm install --save termux`



## Example usage



```javascript

const api = require('termux')



if (!api.hasTermux) process.exit(1)



api.vibrate()

   .duration(1000)

   .run()



api.clipboardGet()

   .run()

   .then(function (text) {

     // ...

   })

```



## Available methods



Every command instance has the `.run()` method that must be used to execute the command. It always return a Promise (eventually with results).



| Method | Description | Parameters |

|--------|-------------|-----------|

| `.toast()` | Show a toast message | |

| | set the text to show | `.text()` |

| | show the toast for a short while | `.transient()` |

| `.vibrate()` | Vibrate your phone | |

| | set the duration in milliseconds | `.duration()` |

| | force vibration even in silent mode | `.force()` |

| `.batteryStatus()` | Get the status of the device battery | |

| `.cameraInfo()` | Get info about device camera(s) | |

| `.cameraPhoto()` | Take a photo and save it to a file (JPEG format) | |

| | select the camera by ID | `.camera()` |

| | output photo file (NB. use an absolute path!) | `.outputFile()` |

| `.clipboardGet()` | Get the system clipboard text | |

| `.clipboardSet()` | Set the system clipboard text | |

| | text to copy in clipboard | `.text()` |

| `.contactList()` | Set the system clipboard text | |

| `.contactList()` | List all contacts | |

| `.dialog()` | Show a text entry dialog | |

| | dialog title | `.title()` |

| | hint to show when input is empty | `.hint()` |

| | use a textarea with multiple lines | `.multipleLines()` |

| | enter the input as a password | `.password()` |

| `.download()` | Download a resource using the download manager | |

| | set the resource to download | `.url()` |

| | title for the download request | `.title()` |

| | description for the download request | `.description()` |

| `.infraredFrequencies()` | Query the infrared transmitter's supported carrier frequencies | |

| `.infraredTransmit()` | Transmit an infrared pattern | |

| | specify the pattern to transmit as array of numbers | `.frequency()` |

| `.location()` | Get the device location | |

| | location provider (gps/network/passive) | `.provider()` |

| | kind of request to make (once/last/updates) | `.request()` |

| `.notification()` | Display a system notification | |

| | notification content to show | `.content()` |

| | notification id (will overwrite any previous notification with the same id)| `.id()` |

| | notification title to show | `.title()` |

| | notification url when clicking on it | `.url()` |

| | notification action when clicking on button1 | `.button1(, )` |

| | notification action when clicking on button2 | `.button2(, )` |

| | notification action when clicking on button3 | `.button3(, )` |

| | notification action when tapping on it | `.tap()` |

| | notification action when deleting it | `.delete()` |

| | notification image to show | `.image()` |

| | makes notification unremovable, need .id  | `.pin()` |

| `.share()` | share a file specified as argument | |

| | provide a file to share | `.file()` |

| | which action to perform on the file (edit/send/view) | `.action()` |

| | content-type to use (default: guessed from file extension) | `.contentType()` |

| | share to the default receiver instead of showing a chooser | `.default()` |

| | title to use for shared content (default: shared file name) | `.title()` |

| `.smsInbox()` | List received SMS messages | |

| | show dates when messages were created | `.date()` |

| | limit in sms list (default: 10) | `.limit()` |

| | show phone numbers | `.showNumbers()` |

| | offset in sms list (default: 0) | `.offset()` |

| `.smsSend()` | Send a SMS message to the specified recipient number(s) | |

| | Recipient number(s), gotta be an Array | `.numbers()` |

| | The SMS text | `.text()` |

| `.telephonyCellInfo()` | Get information about all observed cell information from all radios on the device | |

| `.telephonyDeviceInfo()` | Get information about the telephony device | |

| `.ttsEngines()` | Get information about the available text-to-speech (TTS) engines | |

| `.ttsSpeak()` | Speak text with a system text-to-speech (TTS) engine | |

| | Text to speak, passed to the engine | `.text()` |

| | TTS engine to use, see `.ttsEngines()` | `.engine()` |

| | language to use (may be unsupported by the engine) | `.language()` |

| | pitch to use in speech (1.0 is normal) | `.pitch()` |

| | speech rate to use (1.0 is normal) | `.rate()` |

| | audio stream to use (ALARM/MUSIC/NOTIFICATION/RING/SYSTEM/VOICE_CALL) | `.stream()` |



## Dependency



It uses [has-termux-api](https://github.com/roccomuso/has-termux-api) to check if termux-api is installed.



## Debug



Set the env DEBUG: `DEBUG=termux`



# Author



Rocco Musolino ([@roccomuso](https://twitter.com/roccomuso))



# License



MIT