Document metadata

Application name

CSK_Module_FileManager

Version

1.1.0

Date

2024-11-12

Author

SICK AG

Crowns

C

CSK_FileManager

Short description

Module to provide device file management functionalities like creating / removing folders, downloading / uploading files.
Please check the UI of this module.

Overview

Functions

CSK_FileManager.createFolder()
Short description

Function to create new folder at preset location (check 'setPath').

Sample (auto-generated)
CSK_FileManager.createFolder()
CSK_FileManager.deleteFile()
Short description

Function to delete preselected file (see 'selectFile').

Sample (auto-generated)
CSK_FileManager.deleteFile()
CSK_FileManager.deleteFolder()
Short description

Function to delete preset folder (check 'setPath').

Sample (auto-generated)
CSK_FileManager.deleteFolder()
CSK_FileManager.fileUploadFinished()
Short description

Function to react on file upload (used to give feedback for upload process).

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
CSK_FileManager.fileUploadFinished(status)
CSK_FileManager.getStatusModuleActive()
Short description

Function to get status if module is active.

Return values
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
status = CSK_FileManager.getStatusModuleActive()
CSK_FileManager.pageCalled()
Short description

Function to register "OnResume" of the module UI (only as helper function).

Return values
Name Type Multiplicity Description

empty

STRING

1

Empty string (only needed to simplify binding).
Sample (auto-generated)
empty = CSK_FileManager.pageCalled()
CSK_FileManager.selectFile()
Short description

Function to select file out of filelist.

Parameters
Name Type Multiplicity Description

filename

STRING

1

Full name of selected file (incl. path to it).
Sample (auto-generated)
CSK_FileManager.selectFile(filename)
CSK_FileManager.selectFileSource()
Short description

Function to select source of files.

Parameters
Name Type Multiplicity Description

source

STRING

1

Source of files (e.g. '/public', '/ram').
Sample (auto-generated)
CSK_FileManager.selectFileSource(source)
CSK_FileManager.setPath()
Short description

Function to set path to e.g. uploaded files, create folder.

Parameters
Name Type Multiplicity Description

path

STRING

1

Path
Sample (auto-generated)
CSK_FileManager.setPath(path)
CSK_FileManager.updateListOfFiles()
Short description

Function to update list of files.

Sample (auto-generated)
CSK_FileManager.updateListOfFiles()

Events

CSK_FileManager.OnDataLoadedOnReboot
Short description

Event to call if module tried to load parameters and should be ready.

Sample (auto-generated)
function handleOnDataLoadedOnReboot()
  -- Do something
end

Script.register("CSK_FileManager.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
CSK_FileManager.OnNewParameterName
Short description

Notify name of persistent data parameter.

Callback arguments
Name Type Multiplicity Description

name

STRING

1

Parameter name
Sample (auto-generated)
function handleOnNewParameterName(name)
  -- Do something
end

Script.register("CSK_FileManager.OnNewParameterName", "handleOnNewParameterName")
CSK_FileManager.OnNewStatusAvailableSources
Short description

Notify available file sources.

Callback arguments
Name Type Multiplicity Description

sources

STRING

1

List of sources.
Sample (auto-generated)
function handleOnNewStatusAvailableSources(sources)
  -- Do something
end

Script.register("CSK_FileManager.OnNewStatusAvailableSources", "handleOnNewStatusAvailableSources")
CSK_FileManager.OnNewStatusCalloutText
Short description

Notify text for UI callout.

Callback arguments
Name Type Multiplicity Description

text

STRING

1

Text
Sample (auto-generated)
function handleOnNewStatusCalloutText(text)
  -- Do something
end

Script.register("CSK_FileManager.OnNewStatusCalloutText", "handleOnNewStatusCalloutText")
CSK_FileManager.OnNewStatusCalloutType
Short description

Notify type of UI callout.

Callback arguments
Name Type Multiplicity Description

type

STRING

1

Type
Sample (auto-generated)
function handleOnNewStatusCalloutType(type)
  -- Do something
end

Script.register("CSK_FileManager.OnNewStatusCalloutType", "handleOnNewStatusCalloutType")
CSK_FileManager.OnNewStatusCSKStyle
Short description

Notify UI style to use for CSK modules.

Callback arguments
Name Type Multiplicity Description

theme

STRING

1

UI style
Sample (auto-generated)
function handleOnNewStatusCSKStyle(theme)
  -- Do something
end

Script.register("CSK_FileManager.OnNewStatusCSKStyle", "handleOnNewStatusCSKStyle")
CSK_FileManager.OnNewStatusDiskInfo
Short description

Notify free / used space of the selected file source.

Callback arguments
Name Type Multiplicity Description

info

STRING

1

Info
Sample (auto-generated)
function handleOnNewStatusDiskInfo(info)
  -- Do something
end

Script.register("CSK_FileManager.OnNewStatusDiskInfo", "handleOnNewStatusDiskInfo")
CSK_FileManager.OnNewStatusDownloadFilename
Short description

Notify name for file to download.

Callback arguments
Name Type Multiplicity Description

filename

STRING

1

Name of file.
Sample (auto-generated)
function handleOnNewStatusDownloadFilename(filename)
  -- Do something
end

Script.register("CSK_FileManager.OnNewStatusDownloadFilename", "handleOnNewStatusDownloadFilename")
CSK_FileManager.OnNewStatusFileList
Short description

Notify list of available files.

Callback arguments
Name Type Multiplicity Description

list

STRING

1

List of files.
Sample (auto-generated)
function handleOnNewStatusFileList(list)
  -- Do something
end

Script.register("CSK_FileManager.OnNewStatusFileList", "handleOnNewStatusFileList")
CSK_FileManager.OnNewStatusFileToDownload
Short description

Notify full path to file to download.

Callback arguments
Name Type Multiplicity Description

path

STRING

1

Path
Sample (auto-generated)
function handleOnNewStatusFileToDownload(path)
  -- Do something
end

Script.register("CSK_FileManager.OnNewStatusFileToDownload", "handleOnNewStatusFileToDownload")
CSK_FileManager.OnNewStatusLoadParameterOnReboot
Short description

Notify status if parameters should be loaded on app/device boot up.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnNewStatusLoadParameterOnReboot(status)
  -- Do something
end

Script.register("CSK_FileManager.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
CSK_FileManager.OnNewStatusModuleIsActive
Short description

Notify if module can be used on device.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnNewStatusModuleIsActive(status)
  -- Do something
end

Script.register("CSK_FileManager.OnNewStatusModuleIsActive", "handleOnNewStatusModuleIsActive")
CSK_FileManager.OnNewStatusModuleVersion
Short description

Notify version of module.

Callback arguments
Name Type Multiplicity Description

version

STRING

1

Version
Sample (auto-generated)
function handleOnNewStatusModuleVersion(version)
  -- Do something
end

Script.register("CSK_FileManager.OnNewStatusModuleVersion", "handleOnNewStatusModuleVersion")
CSK_FileManager.OnNewStatusPath
Short description

Notify path to e.g. store uploaded files, create new / remove folder.

Callback arguments
Name Type Multiplicity Description

path

STRING

1

Path
Sample (auto-generated)
function handleOnNewStatusPath(path)
  -- Do something
end

Script.register("CSK_FileManager.OnNewStatusPath", "handleOnNewStatusPath")
CSK_FileManager.OnNewStatusSelectedFile
Short description

Notify name of file selected within list of files.

Callback arguments
Name Type Multiplicity Description

filename

STRING

1

Name of file.
Sample (auto-generated)
function handleOnNewStatusSelectedFile(filename)
  -- Do something
end

Script.register("CSK_FileManager.OnNewStatusSelectedFile", "handleOnNewStatusSelectedFile")
CSK_FileManager.OnNewStatusSelectedSource
Short description

Notify selected file source.

Callback arguments
Name Type Multiplicity Description

source

STRING

1

Source
Sample (auto-generated)
function handleOnNewStatusSelectedSource(source)
  -- Do something
end

Script.register("CSK_FileManager.OnNewStatusSelectedSource", "handleOnNewStatusSelectedSource")
CSK_FileManager.OnNewStatusShowCallout
Short description

Notify status if UI callout should be shown.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnNewStatusShowCallout(status)
  -- Do something
end

Script.register("CSK_FileManager.OnNewStatusShowCallout", "handleOnNewStatusShowCallout")
CSK_FileManager.OnPersistentDataModuleAvailable
Short description

Notify status if features of CSK_PersistendData module are available.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnPersistentDataModuleAvailable(status)
  -- Do something
end

Script.register("CSK_FileManager.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
CSK_FileManager.OnUserLevelAdminActive
Short description

Status of Admin userlevel. Used internally in combination with the CSK_UserManagement module if available.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnUserLevelAdminActive(status)
  -- Do something
end

Script.register("CSK_FileManager.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_FileManager.OnUserLevelMaintenanceActive
Short description

Status of Maintenance userlevel. Used internally in combination with the CSK_UserManagement module if available.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnUserLevelMaintenanceActive(status)
  -- Do something
end

Script.register("CSK_FileManager.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_FileManager.OnUserLevelOperatorActive
Short description

Status of Operator userlevel. Used internally in combination with the CSK_UserManagement module if available.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnUserLevelOperatorActive(status)
  -- Do something
end

Script.register("CSK_FileManager.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_FileManager.OnUserLevelServiceActive
Short description

Status of Service userlevel. Used internally in combination with the CSK_UserManagement module if available.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnUserLevelServiceActive(status)
  -- Do something
end

Script.register("CSK_FileManager.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

CSK_Module_FileManager

Short description

This is an automatically generated CROWN (description not necessary).