{"id":18318438,"url":"https://github.com/oceanstreamio/iotedge-filenotifier","last_synced_at":"2025-04-09T13:54:16.649Z","repository":{"id":250435938,"uuid":"830496214","full_name":"OceanStreamIO/iotedge-filenotifier","owner":"OceanStreamIO","description":null,"archived":false,"fork":false,"pushed_at":"2024-07-27T11:21:42.000Z","size":159,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-15T07:51:15.087Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OceanStreamIO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-18T11:42:47.000Z","updated_at":"2024-07-27T11:21:46.000Z","dependencies_parsed_at":"2024-07-27T12:57:33.955Z","dependency_job_id":null,"html_url":"https://github.com/OceanStreamIO/iotedge-filenotifier","commit_stats":null,"previous_names":["oceanstreamio/iotedge-filenotifier"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanStreamIO%2Fiotedge-filenotifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanStreamIO%2Fiotedge-filenotifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanStreamIO%2Fiotedge-filenotifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanStreamIO%2Fiotedge-filenotifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OceanStreamIO","download_url":"https://codeload.github.com/OceanStreamIO/iotedge-filenotifier/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248054218,"owners_count":21039951,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T18:09:36.864Z","updated_at":"2025-04-09T13:54:16.628Z","avatar_url":"https://github.com/OceanStreamIO.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @oceanstream/filenotifier \n\nFile and directory notifier module for [OceanStream](https://oceanstream) data platform based on the Azure IoT Edge framework.\n\n## Description\n\nThe primary objective of the FileNotifier module is to:\n\n1. monitor specified folders for any file activities, specified by extension (by default `.raw` data files);\n2. dispatch periodic state updates related to file and folder activities to the IoT Hub;\n3. idle detection based on file inactivity – if no file operations are detected within a predefined time interval (default 2 minutes), the system transitions to an \"offline\" state\n4. serve as a source of metadata and other relevant information related to the equipment operation.\n\n## Parameters\n\n| Parameter                | Description                                                                                                   | Default Value         | Data Type   |\n|--------------------------|---------------------------------------------------------------------------------------------------------------|-----------------------|-------------|\n| `RAW_DATA_FOLDER`        | Specifies the directory to monitor for `.raw` data files.                                                      | `/app/tmpdata`        | String      |\n| `alertTimeDiff`          | Time in milliseconds to wait until changing the state to ALARM if no file activity is detected.                | `120000` ms (2 mins)  | Number      |\n| `logLevel`               | Sets the verbosity level for logging. Possible values: `'debug'`, `'info'`, `'warn'`, `'error'`.               | `debug`               | String      |\n| `logFormat`              | Determines the format of the log, either `json` for structured logs or `text` for plain text logs.             | `text`                | String      |\n| `logTimestamp`           | Whether to include timestamps in the log entries.                                                              | `false`               | Boolean     |\n| `alertSendingInterval`   | Interval (in custom units defined by `alertSendingIntervalUnit`) between consecutive state update messages.    | `30`                  | Number      |\n| `alertSendingIntervalUnit`| Unit of time, in milliseconds, for `alertSendingInterval`.                                                    | `60000` ms (1 min)    | Number      |\n| `connectMaxTimeout`      | Maximum timeout, in milliseconds, for status check.                                                            | `90000` ms (1.5 mins) | Number      |\n| `connectMinTimeout`      | Minimum timeout, in milliseconds, for status check.                                                            | `100` ms              | Number      |\n| `filePollingInterval`    | Interval, in milliseconds, at which the `chokidar` library checks for file or folder changes.                  | `10000` ms (10 secs)  | Number      |\n| `continuousProcessing`   | Flag to indicate whether files should be processed continuously or not.                                        | `false`               | Boolean     |\n| `enableRawFileProcessing`| Flag to control whether to send raw files for further processing or not.                                       | `true`                | Boolean     |\n| `fileWatchThreshold`     | Time duration, in milliseconds, to watch for changes before raising an event.                                  | `10000` ms (10 secs)  | Number      |\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foceanstreamio%2Fiotedge-filenotifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foceanstreamio%2Fiotedge-filenotifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foceanstreamio%2Fiotedge-filenotifier/lists"}