Git Product home page Git Product logo

amx-ftp's Introduction

amx-ftp

Send and retrieve files over FTP from an AMX Netlinx processor

NPM

Build status codecov

Installation

$ 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

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

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

{
  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

amx-ftp's People

Contributors

ashleymarkfletcher avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.