Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ashleymarkfletcher/amx-ftp
Send and retrieve files over FTP from AMX Netlinx processor
https://github.com/ashleymarkfletcher/amx-ftp
amx ftp netlinx nodejs npm-package
Last synced: about 1 month ago
JSON representation
Send and retrieve files over FTP from AMX Netlinx processor
- Host: GitHub
- URL: https://github.com/ashleymarkfletcher/amx-ftp
- Owner: ashleymarkfletcher
- Created: 2017-10-09T15:23:33.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-12-18T22:52:44.000Z (about 7 years ago)
- Last Synced: 2024-09-27T09:20:38.247Z (3 months ago)
- Topics: amx, ftp, netlinx, nodejs, npm-package
- Language: JavaScript
- Size: 111 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# amx-ftp
Send and retrieve files over FTP from an AMX Netlinx processor
[](https://nodei.co/npm/amx-ftp/)
[](https://ci.appveyor.com/project/ashleymarkfletcher/amx-ftp)
[](https://codecov.io/gh/ashleymarkfletcher/amx-ftp)
## Installation
```bash
$ npm install amx-ftp --save
```
## Requirements
As of version 2.0, it is recommended to use node version 8 or higher due to the use of async/await.
## Features
* Get all txt files from an AMX processor
* Send files to an AMX processor
## Example Usage Node.js
Get all the files from the processor
```js
const amxFtp = require('amx-ftp')
amxFtp.getFiles({ host: '192.168.20.20' })
.then(() => {
console.log('files retrieved!')
})
.catch((err) => {
console.log('oh no! ', err)
})
```
Send a file to a processor
```js
const amxFtp = require('amx-ftp')
amxFtp.sendFile({ host: '192.168.20.20', fileName: 'test.txt'})
.then(() => {
console.log('file sent!')
})
.catch((err) => {
console.log('oh no! ', err)
})
```
## Defaults
Both getFiles and sendFile have default parameters than can be overridden
```js
{
host: '127.0.0.1',
port: 21,
user: 'administrator',
password: 'password',
path: 'ftpFiles'
}
```
## ToDo
* Add methods for just retrieving a list of files.
* Add method to pull individual file
* Add CLI support
## Devices Tested
So far this has only been test with NX processors but should work with any Netlinx Processor