Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rzr/iotjs-express
Basic reimplementation of Express.js for IoT.js or Node
https://github.com/rzr/iotjs-express
iot js
Last synced: about 2 months ago
JSON representation
Basic reimplementation of Express.js for IoT.js or Node
- Host: GitHub
- URL: https://github.com/rzr/iotjs-express
- Owner: rzr
- License: mit
- Created: 2019-02-22T19:49:27.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-18T01:22:56.000Z (about 1 year ago)
- Last Synced: 2024-10-24T20:06:10.337Z (2 months ago)
- Topics: iot, js
- Language: JavaScript
- Homepage: https://mastodon.social/@rzr/104228324508952903#:IotJsExpress
- Size: 242 KB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# IOTJS-EXPRESS #
[](
https://GitHub.com/rzr/iotjs-express/network/
)
[](MIT)
[](
https://travis-ci.org/rzr/iotjs-express
)
[](
https://www.npmjs.com/package/iotjs-express
)
[](
https://www.jsdelivr.com/package/npm/iotjs-express
)
[](
https://kiwiirc.com/client/irc.freenode.net/#iot
)
[](
https://hub.docker.com/r/rzrfreefr/iotjs-express
)
[](
https://cloud.docker.com/repository/docker/rzrfreefr/iotjs-express/timeline
)
[](
https://hub.docker.com/r/rzrfreefr/iotjs-express/builds
)
[](
https://codebeat.co/projects/github-com-rzr-iotjs-express-master
)
[](
https://app.codacy.com/app/rzr/iotjs-express?utm_source=github.com&utm_medium=referral&utm_content=rzr/iotjs-express&utm_campaign=Badge_Grade_Dashboard
)
[](
https://bestpractices.coreinfrastructure.org/projects/3297
)
[](
https://mastodon.social/@rzr/104148998830650482#IotJsExpress#
)
[](
https://npmjs.org/package/iotjs-express
)
## INTRODUCTION ##
While ExpressJs claims to be minimalist,
many dependencies are required and thus can't support IoT.js runtime
(powered by JerryScript an alternative engine for MicroControllers).
Instead of porting the whole project to older ECMA standards,
basic routing was re-implemented, and API tried to be preserved.
Originally this module was done for "webthing-iotjs" project,
a library to build webthings to connect to WebThingsIo gateway.
Source file was bundled into project, but then pulled out as this standalone module,
which can be used by both runtime Node.Js and IoT.js.
[](
https://www.slideshare.net/rzrfreefr/webthingiotjs20181022rzr-120959360/#
"WebThingIotJs")
## USAGE WITH IOTJS ##
```sh
mkdir iotjs_modules
git clone https://github.com/rzr/iotjs-express iotjs_modules/iotjs-express
cd iotjs_modules/iotjs-express
make start &
#| iotjs example
curl -i http://localhost:8080/.well-known/security.txt
#| HTTP/1.1 200 OK
#| access-control-allow-origin: *
#| access-control-allow-headers: Origin, X-Requested-With, Content-Type, Accept
#| access-control-allow-methods: GET, HEAD, PUT, POST, DELETE
#|
#| Contact: https://www.npmjs.com/~rzr
curl -i http://localhost:8080/favicon.ico
#| HTTP/1.1 404 Not Found
#| content-length: 23
#| Error: 404 (Not Found)
curl -i http://localhost:8080/~rzr
#| {"user":"rzr"}
curl -X PUT -d '{"value":42}' http://localhost:8080/db/some-key
#| {"some-key":42}
curl -X PUT -d '{"value":1984}' http://localhost:8080/db/some-other-key
#| {"some-key":42,"some-other-key":1984}
curl -i http://localhost:8080/static/README.md
#| HTTP/1.1 200 OK
#| # IOTJS-EXPRESS #
#| (...)
```
[](
https://www.slideshare.net/rzrfreefr/webthingiotjstizenrtcdl201820181117rzr/24
"iotjs_modules")
## USAGE WITH NODE ##
It's mostly the same:
```sh
npm install iotjs_express
cd node_modules/iotjs-express
npm start
# Or:
make start runtime=node
#| node example
```
## USAGE WITH DOCKER ##
```sh
docker run --net host rzrfreefr/iotjs-express:latest
curl http://localhost:8080/.well-known/security.txt
#| Contact: https://www.npmjs.com/~rzr
# Or from sources
docker-compose up
curl http://localhost:8080/.well-known/security.txt
#| Contact: https://www.npmjs.com/~rzr
```
## USAGE WITH MINIKUBE ##
```sh
name="iotjs-express"
url="https://raw.githubusercontent.com/rzr/iotjs-express/master/extra/tools/kube/$name.yml"
url=https://raw.githubusercontent.com/rzr/iotjs-express/sandbox/rzr/devel/master/extra/tools/kube/$name.yml
kubectl=kubectl
minikube version
minikube start || minikube logs --alsologtostderr
$kubectl version
$kubectl apply -f "${url}"
#| deployment.extensions/iotjs-express created
#| service/iotjs-express created
time minikube service ${name} --url
#| http://192.168.99.102:30080
time minikube service ${name}
#| 🎉 Opening kubernetes service default/iotjs-express in default browser...
```
## USAGE WITH K3S ##
```sh
project="iotjs-express"
image="rzrfreefr/${project}:latest"
kubectl="sudo kubectl"
sudo sync
sudo snap remove microk8s
curl -sfL https://get.k3s.io | sh - # v0.7.0
sudo systemctl restart k3s.service || sudo systemctl status k3s.service
$kubectl get nodes # Wait "Ready state"
#| {host} NotReady master 5s v1.14.4-k3s.1
#| (...)
#| {host} Ready master 51s v1.14.4-k3s.1
$kubectl run "${project}" --image="${image}"
$kubectl get all --all-namespaces | grep "$project"
#| default pod/iotjs-express-...-... 1/1 Running 0 ..s
pod=$($kubectl get all --all-namespaces \
| grep -o "pod/${project}.*" | cut -d/ -f2 | awk '{ print $1}' \
|| echo failure) && echo pod="$pod"
$kubectl describe pod "$pod" | grep 'Status: Running'
ip=$($kubectl describe pod "$pod" | grep 'IP:' | awk '{ print $2 }') && echo "ip=${ip}"
curl http://$ip:8080/.well-known/security.txt
```
## DEMO ##
In "webthing-iotjs-20180621rzr" video,
Edison's running a webthing server powered by iotjs-express framework to build routes,
(it relies on IoT.js's http module, API is aligned to node)
[](
https://mastodon.social/@rzr/103595181296044323#webthing-iotjs-20180621rzr
"Demo")
*
Demo also shows following systems:
* Edison: iotjs-express + webthing-iotjs on Jubilinux (Debian fork).
* RaspberryPi: webthings-gateway + express.js on Raspbian
* Galaxy note: SamsungInternet web browser for Android.
## EXTRA EXAMPLES ##
```sh
iotjs example/client.js 8080 localhost /.well-known/security.txt
Contact: https://www.npmjs.com/~rzr
```
An extra example is added to show how to make a bridge from HTTP/REST to MQTT.
## RESOURCES ##
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
* (Open)
*
* (Merged)
* (Merged)