Giter Club home page Giter Club logo

flashairjs's Introduction

FlashAir Javascript Client Library

TOSHIBA FlashAir(TM) is a SD memory card which is capable of serving the contents of SD memory card to the remote devices through WiFi. Connection methods are prepared in several ways.

  1. Direct access form web browser. Any modern web browsers can browse the files in directories by typing the host URL( http://flashair/ )
  2. API access. FlashAir also provides API as a form of CGI calls. This is the method that this library utilizes.
  • supports FlashAir(TM) TOSHIBA, WiFi capable SD memory card.
  • wraps all CGI calls, HTTP connections and change notifications.
  • available in TypeScript(ts), Javascript(js) compatible with ECMAScript 3
  • only depends on jQuery (for ajax connection and deferred handling)
  • free to use and reuse under MIT license

#Simply to use ./js directory contains compiled javascript files in 2 styles.

  • flashAirClient.js Non-minified version javascript file, which is compiled from TypeScript source files.
  • flashAirClient.min.js minified version of flashAirClient.js . Source map file is available in conjunction with this.

Include jQuery and flashAirClient.js file in your project.

The simplest example is like this

<script src="js/jquery-[version].js"></script>
<script src="js/flashAirClient.js"></script>
<script>
	var fa = new FlashAir.FlashAirClient("http://flashair/");
	fa.Command.FileList("/")
		.done( function(list){
			$.each(list, function(i, file){
			console.log( file );
			// file is in a form of FileInfoRaw { r_uri, fname, ... }
		});
</script>

API documentation is located under doc directory.

#How to compile TypeScript source files

gulp to compile TypeScript source files.

####Requirement

  • NodeJS anyways.
  • tsd can be installed by npm install -g tsd

####install node modules.

npm install

####install TypeScript definition files ( just for jquery )

tsd update

####gulp to compile ts sources and doc files.

gulp

Applications

Applications that use this library are published:

##Compatilibity Tested with FlashAir(TM) model W-03.

##Version History

  • 0.9.5 to make v1 firmware compatible.
  • 0.9.4 (2015.6.20) initial release

##License (c) 2015 Yokinsoft Jake.Y.Yoshimura http://www.yo-ki.com MIT License

https://github.com/JakeJP/FlashAirJS

flashairjs's People

Contributors

jakejp avatar

Stargazers

Hackbard avatar Joel Saltzman avatar SENTHILKUMAR S avatar Ahmad Awais โŒ˜ avatar Jamez Picard avatar Matija Stepanic avatar H avatar  avatar  avatar Louis Lam avatar Martin Doubek avatar Trevor Lazarus avatar  avatar Karl Espiritu avatar Don avatar Thee Sritabtim avatar Barry avatar Michael Binks avatar  avatar Geunpil Kwon avatar Aliaksei Chapyzhenka avatar Pietro avatar Zhizhou Li avatar Brian Boatright avatar  avatar Hidekazu Tanaka avatar

Watchers

Cirdog avatar  avatar Clem avatar James Cloos avatar Hackbard avatar Florian Schlittenbauer 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.