ohos_ntp
Introduction
ohos_ntp is a TypeScript library for Network Time Protocol (NTP) server synchronization events. It allows your application to obtain accurate event information by communicating with the NTP server to ensure that your device has an accurate system clock or can obtain accurate time information for debugging.
How to Install
ohpm install @ohos/ntp
For details about the OpenHarmony ohpm environment configuration, see OpenHarmony HAR.
How to Use
- Import the dependency.
import { getNetworkTime, NTPConfig } from '@ohos/ntp';
- Add permissions in the module.json5 file.
"requestPermissions": [
{
"name": "ohos.permission.INTERNET"
}
]
- Create an NTPClient instance object in the event or hook function, call getNetworkTime, and use the default value if no parameter is transferred.
const ntpConfig: NTPConfig = {
server: ntp.aliyun.com (NTP server)
port: 123 (remote port number)
delayTime: 3000 (response waiting duration (ms))
}
getNetworkTime(ntpConfig)
.then(date => {
this.ntpResult = JSON.stringify(date); //"2024-02-06T01:50:37.645Z"
})
.catch((err: string) => {
this.timeoutResult = JSON.stringify(err);
})
Available APIs
| API | Parameter | Return Value | Description |
|---|---|---|---|
| getNetworkTime | {server,port,delayTime}:NTPConfig | Promise< Date > | Time to obtain NTP info |
Constraints
This project has been verified in the following version:
- DevEco Studio: NEXT Release(5.0.3.900), SDK: API12 (5.0.0.71)
- DevEco Studio: NEXT Developer Beta3(5.0.3.524), SDK: API12 (5.0.0.25)
- DevEco Studio: 4.1.3.500; SDK: API11 Release (4.1.0)
Directory Structure
|---- ntpclient
| |---- entry # Sample code
| |---- library # NTP library
| |---- src
| |---- main
| |---- ets
| |---- index.ts #ntp
| |---- index.ts # External APIs
| |---- README.md # Readme
| |---- README_zh.md # Readme
About obfuscation
- Code obfuscation, please seeCode Obfuscation
- If you want the ntp library not to be obfuscated during code obfuscation, you need to add corresponding exclusion rules in the obfuscation rule configuration file obfuscation-rules.txt：
-keep
./oh_modules/@ohos/ntp
How to Contribute
If you find any problem when using the project, submit an issue or a PR to us.
License
This project is licensed under Apache License 2.0.