Interactive function to consult enable or disable multiple modules for APEX OS

Install using npm github

npm install https://github.com/digitalcomtech/syrus4-sdk-nodejs/tarball/master

Accelerometer

Accelerometer module get information about hardware acceleration and events in ApexOS

Apps

Apps module to start/stop/enable/disable/install third parts apps running in apex-os

Bluetooth

Bluetooth module, get information about bluetooth state

Counters

Counters module setup get and set counters from APEX OS

Database

Logrotate module setup get and set counters from APEX OS

ECU

ECU module get information about EcU monitor and vehicle in ApexOS

Fatigue

Fatigue module, get fatigue sensor information and events

GPS

GPS module get information about gps and location in ApexOS

Geofences

Geofences module

Hotspot

Hotspot module to interacte with the enable/disable Hotspot mode with Apex OS

IButton

IButton module get information about onewire

IOExpander

Logrotate module setup get and set counters from APEX OS

IOS

IOS module allow to get and set status from Input and Outputs in Syrus 4 Apex OS

Logrotate

Logrotate module setup get and set counters from APEX OS

Network

Network module get information about networks and events in ApexOS

PeopleCounter

PeopleCounter module setup get and set Safe engine cut of from APEX OS

PulseCounter

Logrotate module setup get and set counters from APEX OS

RFID

RFID module get information about RFID states

SafeEngine

SafeEngine module setup get and set Safe engine cut of from APEX OS

Serial

Serial module, get information about serial state

System-Info

System module get information about ApexOS

Technoton

Technoton module get information about Technoton fuel level

Temperature

Temperature module get information about temperature sensors

Update

Update module check for update and make update for ApexOS

Utils

Utils module some utlities in ApexOS

WIFI

WIFI module to interacte with the enable/disable WIFI mode with Apex OS

Windows

Time Windows module setup get and set counters from APEX OS

getInfo()

returns a JSON with the configured values in RF

set(key, value)

Use this option to configure the network variable for mobile networks

Accelerometer module get information about hardware acceleration and events in ApexOS

• Accelerometer
  • ~onMotionChange(callback, errorCallback)
  • ~on(callback, errorCallback)
  • ~startAutoAlignment(state)
  • ~startSelfAccelerationTest(state)
  • ~isAutoAligning()
  • ~isAccelerationTest()
  • ~isMoving()

Watch the motion state of the Syrus Apex accceleration hardware module

Kind: inner method of Accelerometer

Watch for accelerations events in Apex OS. possible events: FORWARD_COLLISION, BACKWARD_COLLISION, LAT_COLLISION_FROM_RIGHT, LAT_COLLISION_FROM_LEFT, HARSH_FWD_ACCELERATION, HARD_BRAKING, CORNERING_RIGHT, CORNERING_LEFT

Kind: inner method of Accelerometer

Set the state for the auto alignment procces of the APEX OS acceleration hardware

Kind: inner method of Accelerometer

Set the state for the self acceleration test of the APEX OS acceleration hardware

Kind: inner method of Accelerometer

check is hardware is on state auto aligning returns a promise with the state

Kind: inner method of Accelerometer

check is hardware is on state acceleration test returns a promise with the state

Kind: inner method of Accelerometer

Check the current state of the acceloremeter hardware is moving

Kind: inner method of Accelerometer

Apps module to start/stop/enable/disable/install third parts apps running in apex-os

• Apps
  • ~execute(action, app, zipPath, instance, ver)
  • ~installApp(zipPath)
  • ~uninstallApp(app, ver)
  • ~listApps() ⇒
  • ~createInstance(name, app, ver) ⇒
  • ~deleteInstance(name) ⇒
  • ~listInstances() ⇒
  • ~startInstance(name) ⇒
  • ~stopInstance(name) ⇒
  • ~restartInstance(name) ⇒
  • ~setConfiguration(app, newConfig)
  • ~getConfiguration(app)

allows to execute commands from the apps-manager utility from ApexOs

Kind: inner method of Apps

Allows to install an app receive as parameter the name of the app and the zip location or the data of the zip in question.

Kind: inner method of Apps

Uninstall and deletes the data from an app

Kind: inner method of Apps

Lists all the installed applications.

This function executes the "list-apps" action using the execute function from the Utils module. It returns a promise that resolves with the result of the command execution.

Kind: inner method of Apps
Returns: A promise that resolves with the list of installed applications.

Creates an instance of an application.

This function executes the "create-instance" action using the execute function from the Utils module. It returns a promise that resolves with the result of the command execution.

Kind: inner method of Apps
Returns: A promise that resolves with the result of the instance creation.

Deletes an instance of an application.

This function executes the "delete-instance" action using the execute function from the Utils module. It returns a promise that resolves with the result of the instance deletion.

Kind: inner method of Apps
Returns: A promise that resolves with the result of the instance deletion.

Lists all instances of an application.

This function executes the "list-instances" action using the execute function from the Utils module. It returns a promise that resolves with the list of instances.

Kind: inner method of Apps
Returns: A promise that resolves with the list of instances.

Starts an instance of an application.

This function executes the "start-instance" action using the execute function from the Utils module. It returns a promise that resolves with the result of starting the instance.

Kind: inner method of Apps
Returns: A promise that resolves with the result of starting the instance.

Stops an instance of an application.

This function executes the "stop-instance" action using the execute function from the Utils module. It returns a promise that resolves with the result of stopping the instance.

Kind: inner method of Apps
Returns: A promise that resolves with the result of stopping the instance.

Restarts an instance of an application.

This function executes the "restart-instance" action using the execute function from the Utils module. It returns a promise that resolves with the result of restarting the instance.

Kind: inner method of Apps
Returns: A promise that resolves with the result of restarting the instance.

write .env file configuration of the app, if the .env exists, replace it

Kind: inner method of Apps

Get the contents of SYRUS4G_APP_CONF_FILE file where it stored the configuration of the app

Kind: inner method of Apps

Bluetooth module, get information about bluetooth state

Counters module setup get and set counters from APEX OS

Logrotate module setup get and set counters from APEX OS

ECU module get information about EcU monitor and vehicle in ApexOS

• ECU
  • ~getECUInfo()
  • ~watchECUParams(cb, errorCallback)
  • ~getECUParams()
  • ~getECUList()

ECU PARAM LIST from the ecu monitor

Kind: inner method of ECU

allows to subscribe for ECU parameter changes

Kind: inner method of ECU

Get all the most recent data from ECU parameters

Kind: inner method of ECU

get ecu paramas list associated to all the pgn and id for ecu and taip tag associated

Kind: inner method of ECU

Fatigue module, get fatigue sensor information and events

GPS module get information about gps and location in ApexOS

• GPS
  • ~distanceBetweenCoordinates(coord1, coord2)
  • ~getCurrentPosition()
  • ~watchPosition(callback, errorCallback, config)
  • ~watchGPS(callback, errorCallback)
  • ~watchTrackingResolution(callback, opts)
  • ~getActiveTrackingsResolutions(prefixed)
  • ~setTrackingResolution(opts)
  • ~getTrackingResolution(opts)

return distance in km between two coordinates points

Kind: inner method of GPS

Get last current location from GPS

Kind: inner method of GPS

allows to subscribe to position events in GPS module

Kind: inner method of GPS

allows to subscribe to gps data changes in GPS module

Kind: inner method of GPS

define a tracking resolution using apx-tracking tool to receive filtered data gps

Kind: inner method of GPS

get all the active tracking resolutions`in the apex tol apx-tracking

Kind: inner method of GPS

set options for a tracking_resolution for the apex tool apx-tracking

Kind: inner method of GPS

get options for a tracking_resolution for the apex tool apx-tracking

Kind: inner method of GPS

Geofences module

• Geofences
  • ~addGeofence(opts)
  • ~updateGeofence(opts)
  • ~removeGeofence(opts)
  • ~getNamespaces() ⇒ *
  • ~get(opts)
  • ~getAll(opts)
  • ~deleteAll(opts)
  • ~watchGeofencesSpeedLimits(callback, errorCb, opts)
  • ~watchGeofences(callback, errorCb, opts)
  • ~watchGroups(callback, errorCb, opts)

Add Geofence to the apx-tool

Kind: inner method of Geofences

Update Geofence to the apx-tool

Kind: inner method of Geofences

Remove Geofence from the apx-tool

Kind: inner method of Geofences

get all available namespaces

Kind: inner method of Geofences

Get geofence state from the apx-tool

Kind: inner method of Geofences

Get states from all Geofences for a given namespace

Kind: inner method of Geofences

remove all Geofences from the namespace

Kind: inner method of Geofences

Kind: inner method of Geofences

Kind: inner method of Geofences

Kind: inner method of Geofences

Hotspot module to interacte with the enable/disable Hotspot mode with Apex OS

• Hotspot
  • ~list()
  • ~state()
  • ~start()
  • ~stop()
  • ~reset()
  • ~route(netInterface)
  • ~edit(parameter, newValue)

returns the list of the connected clients to the hotspot

Kind: inner method of Hotspot

returns the state of the connected clients to the hotspot

Kind: inner method of Hotspot

start the hotspot service, also stop wifi service

Kind: inner method of Hotspot

stops the hotspot service

Kind: inner method of Hotspot

executes a stop-start in the same call

Kind: inner method of Hotspot

Use this option for forwarding the wlan traffic to another interface, it allows you to have internet access by specifying the output interface

Kind: inner method of Hotspot

edits the parameter received in the hotspot configuration file.
Example apx-hotspot edit wpa_passphrase myNewPass1234 Possible Values: "wpa_passphrase" | "ssid" | "max_num_sta" | "channel" | "wpa_key_mgmt"

Kind: inner method of Hotspot

IButton module get information about onewire

• IButton
  • ~IButtonUpdate
    • new IButtonUpdate()
  • ~getIButtons()
  • ~getIButton()
  • ~setIButtonAlias()
  • ~removeIButtonAlias()
  • ~onIButtonChange()

Kind: inner class of IButton

Event published by the sdk composed of of multiple IButtonEvent authorized contains events from whitelisted ibuttons

allow to get al lthe state of the ibuttons connected

Kind: inner method of IButton

allow to get al lthe state of the ibuttons connected

Kind: inner method of IButton

allow to get al lthe state of the ibuttons connected

Kind: inner method of IButton

remove Alias from ibutton whitelist

Kind: inner method of IButton

monitor iButton notifications

Kind: inner method of IButton

Logrotate module setup get and set counters from APEX OS

IOS module allow to get and set status from Input and Outputs in Syrus 4 Apex OS

• IOS
  • ~watchInputState(inputName, cb, errorCallback)
  • ~getInputState(inputName)
  • ~setOutputState(inputName, state)
  • ~getAll()

Allow to subcribe to changes in a input or output accepts sub patterns

Kind: inner method of IOS

get a promise that resolve the current input or output state

Kind: inner method of IOS

Allow to change the state of an output

Kind: inner method of IOS

Get the current state of all inputs, outputs and analogs in the Syrus4 device

Kind: inner method of IOS

Logrotate module setup get and set counters from APEX OS

Network module get information about networks and events in ApexOS

• Network
  • ~onNetworkChange(callback, errorCallback)
  • ~getActiveNetwork()
  • ~getNetworkInfo(net)
  • ~getNetworks()

Watch the network state change

Kind: inner method of Network

get the current state of the network of the APEX OS, returns a promise with the info

Kind: inner method of Network

get Network Information about specific network

Kind: inner method of Network

get network information about all the available networks on APEX OS

Kind: inner method of Network

PeopleCounter module setup get and set Safe engine cut of from APEX OS

Logrotate module setup get and set counters from APEX OS

RFID module get information about RFID states

• RFID
  • ~RFIDUpdate
    • new RFIDUpdate()

Kind: inner class of RFID

Event published by the sdk composed of multiple RFID authorized contains events from RFID

SafeEngine module setup get and set Safe engine cut of from APEX OS

Serial module, get information about serial state

• Serial
  • ~getSerialMode()
  • ~setSerialMode()
  • ~getSerialModemState()
  • ~getModemBufferSize()
  • ~setModemBufferSize()
  • ~send()

get serial mode: Promise<"console"|"modem"|"unmanaged"|"rfid"|"mdt"|"faitgue_sensor"|"fuel_sensor"|"user">

Kind: inner method of Serial

set serial mode (console or modem)

Kind: inner method of Serial

get serial modem state

Kind: inner method of Serial

get modem buffer size

Kind: inner method of Serial

set the buffer size

Kind: inner method of Serial

send a message

Kind: inner method of Serial

System module get information about ApexOS

• System-Info
  • ~info()
  • ~modem()
  • ~onSleepOn(callback, errorCallback)
  • ~getLastWakeUp()
  • ~getlastSleepOn()
  • ~getWakeUpList()
  • ~addDisconnectListener(callback)
  • ~removeDisconnectListener(callback)

Get Info about the system like RAM,CPU,uptime, etc

Kind: inner method of System-Info

Get Modem about the system like RAM,CPU,uptime, etc

Kind: inner method of System-Info

handler to detect power save mode and execute callback 15 seconds before the device goes to sleep

Kind: inner method of System-Info

Get the latest wakeup reason and timestamp from sleep on from APEX OS

Kind: inner method of System-Info

Get the latest time from sleep on event from APEX OS

Kind: inner method of System-Info

Get the list of latets sleep on and wakeup events with reason and timestamp

Kind: inner method of System-Info

add a callback from stack to execute when app signal termination

Kind: inner method of System-Info

remove a callback from stack to execute when app signal termination

Kind: inner method of System-Info

Technoton module get information about Technoton fuel level

Temperature module get information about temperature sensors

• Temperature
  • ~TemperatureUpdate
    • new TemperatureUpdate()
  • ~getTemperatures()
  • ~getTemperature()
  • ~setTemperatureAlias()
  • ~removeTemperatureAlias()
  • ~removeTemperatureAliases()
  • ~onTemperatureChange()

Kind: inner class of Temperature

Event published by the sdk composed of multiple TemperatureEvents authorized object contains events from whitelisted ibuttons

get the current temperature state

Kind: inner method of Temperature

get reading from a specific sensor, by id or alias

Kind: inner method of Temperature

set alias to a temperature sensor

Kind: inner method of Temperature

remove alias from temperature sensor

Kind: inner method of Temperature

remove aliases from all temperature sensors

Kind: inner method of Temperature

monitor temperature notifications

Kind: inner method of Temperature

Update module check for update and make update for ApexOS

Check if an update is available in the dctserver for OS apps and return a list of the latest version of the packages

Kind: inner method of Update

Utils module some utlities in ApexOS

• Utils
  • ~OSExecute(...args)
  • ~getPrefix() ⇒ *
  • ~$trycatch(promise) ⇒ *
  • ~$throw(error)
  • ~$sleep(ms) ⇒ *

Execute a command using sudo in the shell of the APEXOS and returns a promise with the stdout. Promise is rejected if status code is different than 0

Kind: inner method of Utils

Fetch application prefix, uses env=SYRUS4G_APP_NAME when available otherwise it builds it from the directory where the app is running

Kind: inner method of Utils

Utility for try/catching promises in one line, avoiding the need for try/catch blocks let [response, error] = $trycatch(await awaitable())

Kind: inner method of Utils
Returns: * - {(Promise<[ any | null, Error | null ]>)}

Utility for throwing errors inside a catch, reduces need for try/catch await awaitable().catch($throw)

Kind: inner method of Utils

Sleep Utility await $sleep(10*1000)

Kind: inner method of Utils
Returns: * - {Promise}

WIFI module to interacte with the enable/disable WIFI mode with Apex OS

• WIFI
  • ~scan()
  • ~state()
  • ~list()
  • ~start()
  • ~stop()
  • ~reset()
  • ~add(ssid, password)
  • ~remove(ssid)

It starts a WIFI scan and returns a list of SSIDs

Kind: inner method of WIFI

It returns the wifi status

Kind: inner method of WIFI

It returns the list of networks configured

Kind: inner method of WIFI

It enables the WIFI interface and starts the service for connecting with preconfigured networks

Kind: inner method of WIFI

It stops the WIFI service and disables the interface

Kind: inner method of WIFI

It executes a stop-start in the same call

Kind: inner method of WIFI

It adds a new network to the WIFI configuration file, in this case you have to include the SSID and psk as parameters. Example apx-wifi add myNet myPass

Kind: inner method of WIFI

It removes a network from the WIFI configuration file, in this case you have to include the SSID as parametes

Kind: inner method of WIFI

Time Windows module setup get and set counters from APEX OS

returns a JSON with the configured values in RF

Kind: global function

Use this option to configure the network variable for mobile networks

Kind: global function

© 2020 Digitalcomtech