Value:
- Set this parameter to the ID of the user to be queried.
- If no value is specified, information about the current user is queried.| +| Name | Type | Mandatory| Description| +| ---------- | ------ | ---- | ---- | +| userId | number | No | User ID.
Value:
- Set this parameter to the ID of the user to be queried.
- If no value is specified, information about the current user is queried.| **Return value** - | Type | Description | - | --------------------- | ---------------- | - | Promise<[StorageStats](#StorageStats)> | Promise used to return the information obtained.| +| Type | Description | +| --------------------- | ---------------- | +| Promise<[StorageStats](#storagestats9)> | Promise used to return the information obtained.| **Example** @@ -504,10 +504,10 @@ This is a system API and cannot be called by third-party applications. **Parameters** - | Name | Type | Mandatory| Description | - | ---------- | ------------------------------------ | ---- | -------------------------- | - | userId | number | No | User ID.
Value:
- Set this parameter to the ID of the user to be queried.
- If no value is specified, information about the current user is queried. | - | callback | callback:AsyncCallback<[StorageStats](#StorageStats)> | Yes | Callback invoked to return the information obtained.| +| Name | Type | Mandatory| Description | +| ---------- | ------------------------------------ | ---- | -------------------------- | +| userId | number | No | User ID.
Value:
- Set this parameter to the ID of the user to be queried.
- If no value is specified, information about the current user is queried. | +| callback | callback:AsyncCallback<[StorageStats](#storagestats9)> | Yes | Callback invoked to return the information obtained.| **Example** diff --git a/en/application-dev/reference/arkui-js/js-components-svg-animate.md b/en/application-dev/reference/arkui-js/js-components-svg-animate.md index 751dbe4adb724775bc0cd287b47f29c25cbd2339..f214967694d8534769932d1b1f0e9d95dc54e61f 100644 --- a/en/application-dev/reference/arkui-js/js-components-svg-animate.md +++ b/en/application-dev/reference/arkui-js/js-components-svg-animate.md @@ -1,19 +1,20 @@ -# animate +# animate The **
| @@ -193,7 +194,7 @@ Not supported |
|---|
1. Relative path whose protocol type is `internal`. Example:
Temporary directory: internal://cache/test.mp4
2. Absolute path. Example:
file:///data/data/ohos.xxx.xxx/files/test.mp4| -| parameterOne | [CustomEnum](#Enumeration)| Yes | Yes | Describe the attributes. The requirements are similar to those for the parameter description. | +| parameterOne | [CustomEnum](#enums) | Yes | Yes | Describe the attributes. The requirements are similar to those for the parameter description. | ## Change History | Change Description| Date| diff --git a/en/device-dev/guide/device-iotcamera-control-demo-photodevguide.md b/en/device-dev/guide/device-iotcamera-control-demo-photodevguide.md deleted file mode 100644 index 013f080c0dd6f0fb49f96ecf2cfa380290215f12..0000000000000000000000000000000000000000 --- a/en/device-dev/guide/device-iotcamera-control-demo-photodevguide.md +++ /dev/null @@ -1,391 +0,0 @@ -# Photographing - -## When to Use - -Use the camera module APIs to capture frames \(photographing\). - -## Available APIs - -**Table 1** APIs for photographing - - - - -None - -## How to Develop - -1. Extend the **CameraDeviceCallback** class and call **OnCameraStatus** to customize operations when the camera device changes, for example, when a camera becomes available or unavailable. - - ``` - class SampleCameraDeviceCallback : public CameraDeviceCallback { - void OnCameraStatus(std::string cameraId, int32_t status) override - { - // Do something when camera is available or unavailable. - } - }; - ``` - -2. Extend the **FrameStateCallback** class. After obtaining the frame data, save the data as a file. - - ``` - static void SampleSaveCapture(const char *p, uint32_t size) - { - cout << "Start saving picture" << endl; - struct timeval tv; - gettimeofday(&tv, NULL); - struct tm *ltm = localtime(&tv.tv_sec); - if (ltm != nullptr) { - ostringstream ss("Capture_"); - ss << "Capture" << ltm->tm_hour << "-" << ltm->tm_min << "-" << ltm->tm_sec << ".jpg"; - - ofstream pic("/sdcard/" + ss.str(), ofstream::out | ofstream::trunc); - cout << "write " << size << " bytes" << endl; - pic.write(p, size); - cout << "Saving picture end" << endl; - } - } - - class TestFrameStateCallback : public FrameStateCallback { - void OnFrameFinished(Camera &camera, FrameConfig &fc, FrameResult &result) override - { - cout << "Receive frame complete inform." << endl; - if (fc.GetFrameConfigType() == FRAME_CONFIG_CAPTURE) { - cout << "Capture frame received." << endl; - list
+
The directory structure of the kernel is described as follows:
diff --git a/en/device-dev/security/security-guidelines-overall.md b/en/device-dev/security/security-guidelines-overall.md
index 8c551e4d29637b69eb9d81437eb5360e87bad324..e3c6685ab0b5052b7e15780e0c1f45381e9479cc 100644
--- a/en/device-dev/security/security-guidelines-overall.md
+++ b/en/device-dev/security/security-guidelines-overall.md
@@ -94,7 +94,7 @@ For device with 128 KB to 128 MB of memory, the OpenHarmony lite kernel is recom
- Secure boot must be enabled, and the trusted root must be in the chip and cannot be modified. In addition, you must consider the impact of secure upgrade (if available) on secure boot, that is, the signature or hash value of an image file must be updated after a secure upgrade.
-## Data security
+## Data Security
### Security Mechanism
diff --git a/en/device-dev/security/security-privacy-protection.md b/en/device-dev/security/security-privacy-protection.md
index 71557e17c7a2dde14fba1752b0fcb9d0b0d1b853..334f54d53554bd63054b2531de815f077db96e06 100644
--- a/en/device-dev/security/security-privacy-protection.md
+++ b/en/device-dev/security/security-privacy-protection.md
@@ -1,6 +1,6 @@
-# Privacy Protection
+# Privacy Protection
-## Overview
+## Overview
Personal data plays an increasingly important role in social economy and daily life along with the development of the Internet and informatization. Meanwhile, personal data leakage risks are increasing. As consumer product developers, you shall take more effective measures to protect users' personal data and improve their trust in your products. To protect consumers' privacy and improve their experience on privacy, you should set high-level privacy protection policies for your product.
@@ -49,7 +49,7 @@ Personal data plays an increasingly important role in social economy and daily l
- Users provide information proactively, such as scenarios where a user enters their identification number and bank card number to bind the bank card.
-## Data Classification
+## Data Classification
Data is classified into five levels: very high, high, moderate, low, and public based on the data protection objectives and consequences \(the impact of legal risks caused by data leakage or damage on individuals, organizations, or the public\).
@@ -116,7 +116,7 @@ Data is classified into five levels: very high, high, moderate, low, and public
Note: For details about the definitions of privacy protection and data classification, see GDPR.
-## General Privacy Design Rules
+## General Privacy Design Rules
To help you better complete privacy design for OpenHarmony products, we sort out general privacy design requirements.
@@ -133,7 +133,7 @@ When collecting personal data, clearly and explicitly notify users of the data t
Guided by the preceding principles, we have designed some examples for your reference. The figures below are examples of a privacy notice and a privacy statement, respectively.
- **Figure 1** Examples of a privacy notice and a privacy statement
+ **Figure 1** Examples of a privacy notice and a privacy statement
@@ -190,9 +190,9 @@ You shall obtain consent from users and comply with applicable laws and regulati
Data processing security shall be ensured in technical terms, which include encrypted data storage and secure data transfer. Security mechanisms or measures shall be enabled by default for a system.
-- A protection mechanism shall be available for personal data access, including identity authentication and access control. Identity authentication \(such as username and password\) allows only authenticated users to access data in multi-user scenarios. Access control \(for example, [permission control](security-guidelines-overall.md#section852593153614)\) can be applied to restrict access to applications.
+- A protection mechanism shall be available for personal data access, including identity authentication and access control. Identity authentication \(such as username and password\) allows only authenticated users to access data in multi-user scenarios. Access control \(for example, [permission control](../security/security-guidelines-overall.md)\) can be applied to restrict access to applications.
- Secure storage of personal data on distributed devices must meet Huawei Universal Keystore \(HUKS\) requirements, including secure storage of keys and data.
-- The transfer of personal data between distributed devices must meet the trust binding relationship between devices and security requirements of data transmission channels. For details, see [Security Guidelines](security-guidelines-overall.md#section26153183616).
+- The transfer of personal data between distributed devices must meet the trust binding relationship between devices and security requirements of data transmission channels. For details, see [Device Interconnection Security](../security/security-guidelines-overall.md#device-interconnection-security).
- Authentication data \(such as passwords and fingerprints\) shall be encrypted before being stored.
**Localization**
@@ -203,7 +203,7 @@ User data shall be preferentially processed on the local device. Data that canno
If your product is designed for minors or you can identify, based on the collected user age data, that the end user is a minor, you shall particularly analyze issues related to minors' personal data protection based on relevant national laws in the target market. Your product shall obtain explicit consent from the holders of parental responsibility over minors.
-## **Privacy Protection Requirements for Special Categories**
+## **Privacy Protection Requirements for Special Categories**
In addition to these general privacy requirements, consumer hardware products have the following requirements for special categories. You shall comply with these requirements during product design.
diff --git a/en/device-dev/subsystems/subsys-ai-aiframework-devguide.md b/en/device-dev/subsystems/subsys-ai-aiframework-devguide.md
index 0a65ca9e584e80c6b1bf8662c85e8759b4711750..d1cca7c960f6e22ba52860f799b9fa3e2994338b 100644
--- a/en/device-dev/subsystems/subsys-ai-aiframework-devguide.md
+++ b/en/device-dev/subsystems/subsys-ai-aiframework-devguide.md
@@ -1,4 +1,4 @@
-# AI Framework Development Guide
+# AI Framework Development
## **Overview**
diff --git a/en/device-dev/subsystems/subsys-dfx-hitracechain.md b/en/device-dev/subsystems/subsys-dfx-hitracechain.md
index 6639011302e78ba1e9931b24362c5790c24dd4a3..8e7ded998f75f6fde34134a1240486193431058d 100644
--- a/en/device-dev/subsystems/subsys-dfx-hitracechain.md
+++ b/en/device-dev/subsystems/subsys-dfx-hitracechain.md
@@ -1,10 +1,10 @@
-# HiTraceChain Development
+# HiTraceChain Development
-## Overview
+## Overview
HiTraceChain tracks the call chain with the same **traceid** throughout the inter-device, inter-process, and inter-thread service processes. It associates and displays the call relationship and various output information during the entire process, helping you analyze and locate faults and optimize the system.
-## Use Cases
+## Use Cases
HiTraceChain can be used for the following purposes:
@@ -14,32 +14,36 @@ HiTraceChain can be used for the following purposes:
- Works with the IDE to debug the detailed service process and time consumption distribution for system optimization.
- **Figure 1** Use cases of HiTraceChain
+ **Figure 1** Use cases of HiTraceChain
+
-### Usage Example
+### Usage Example
+
+**Figure 2** Service calling process \(inter-device and inter-process synchronous call\)
-**Figure 2** Service calling process \(inter-device and inter-process synchronous call\)
.png "service-calling-process-(inter-device-and-inter-process-synchronous-call)")
-1. Display the call relationship in the service process, analyze key paths and function dependency, and determine the time consumption and call frequency at each call point to detect performance bottlenecks.
+1. Display the call relationship in the service process, analyze key paths and function dependency, and determine the time consumption and call frequency at each call point to detect performance bottlenecks.
+
+ **Figure 3** Service calling process
- **Figure 3** Service calling process
- 
+ 
- **Figure 4** Time delay in the service calling process
- 
+ **Figure 4** Time delay in the service calling process
+
+ 
2. Add **traceid** to logs and events automatically to facilitate comprehensive analysis and quick fault location.
-## Available APIs
+## Available APIs
HiTraceChain provides C++ and C APIs. The upper-layer services mainly use HiTraceChain to start and stop call chain tracing.
HiTraceChain is implemented at layer C. It works by transferring **traceid** throughout the service calling process. Before service processing, HiTraceChain sets **traceid** in the thread local storage \(TLS\) of the calling thread. During service processing, HiTraceChain obtains **traceid** from the contextual TLS of the calling thread and automatically adds it to the log and event information. After service processing is complete, HiTraceChain clears **traceid** from the TLS of the calling thread.
-### Java, C++, and C APIs
+### Java, C++, and C APIs
**Table 1** Description of C++ and C APIs
@@ -195,7 +199,7 @@ HiTraceChain is implemented at layer C. It works by transferring **traceid** t
-### Parameters of C++ APIs
+### Parameters of C++ APIs
**Table 2** Parameters of C++ APIs
@@ -428,7 +432,7 @@ HiTraceChain is implemented at layer C. It works by transferring **traceid** t
-## Call Chain Processing
+## Call Chain Processing
Inter-device, inter-process, and inter-thread calls are implemented through the communication mechanism. **HiTraceChain** requires transfer of **traceid** in the communication mechanism.
@@ -438,7 +442,8 @@ The following figure shows the process of transferring **traceid** in synchron
Extended communication mechanisms can also follow this implementation.
-**Figure 5** Call chain tracing in synchronous communication
+**Figure 5** Call chain tracing in synchronous communication
+
The process is as follows:
@@ -471,9 +476,9 @@ The process is as follows:
8. The service module on the client processes the transact reply response.
9. When the process ends, the service module on the client calls the **end\(\)** function to stop call chain tracing.
-## How to Develop
+## How to Develop
-### C++
+### C++
1. Develop the source code.
@@ -499,7 +504,7 @@ The process is as follows:
```
-### C
+### C
1. Develop the source code.
diff --git a/en/device-dev/subsystems/subsys-tel-guide.md b/en/device-dev/subsystems/subsys-tel-guide.md
index 9b204051bd6742a6cd6afbf550d67f8ac8186c9e..9ddc0393b11c42349822e2dbd1d30d8875d848c4 100644
--- a/en/device-dev/subsystems/subsys-tel-guide.md
+++ b/en/device-dev/subsystems/subsys-tel-guide.md
@@ -1,8 +1,8 @@
-# Telephony Development
+# Telephony Development
-## Initializing a Modem Vendor Library
+## Initializing a Modem Vendor Library
-### When to Use
+### When to Use
Initializing a modem vendor library means to implement **const HRilOps \*RilInitOps\(const struct HRilReport \*reportOps\)** function in the vendor library. This function is mainly used to:
@@ -10,17 +10,17 @@ Initializing a modem vendor library means to implement **const HRilOps \*RilInit
- Create a thread for reading modem nodes. In this thread, the data reported by the modem is read cyclically and parsed as a specific service event for reporting.
- Return the function pointer of the service request API to RIL Adapter.
-### Available APIs
+### Available APIs
The following table describes the API for initializing a modem vendor library.
**Table 1** API for initializing a modem vendor library
-| API | Description |
+| API | Description |
| -------- | -------- |
-| const HRilOps \*RilInitOps(const struct HRilReport \* reportOps) | Provides an entry for running a modem vendor library.Input parameter:
**reportOps**: Specifies the pointer to the event callback function, which is passed by RIL Adapter.
Return result: function pointer of the service request API. | +| const HRilOps \*RilInitOps(const struct HRilReport \* reportOps) | Provides an entry for running a modem vendor library.
Input parameter:
**reportOps**: Specifies the pointer to the event callback function, which is passed by RIL Adapter.
Return result: function pointer of the service request API. | -### How to Develop +### How to Develop 1. Set the event callback function pointers passed by RIL Adapter through **RilInitOps**. @@ -37,7 +37,7 @@ The following table describes the API for initializing a modem vendor library. ``` -1. Create the **g\_reader** main thread to enable message looping. +2. Create the **g\_reader** main thread to enable message looping. ``` pthread_attr_t t; @@ -47,7 +47,7 @@ The following table describes the API for initializing a modem vendor library. ``` -1. In the **g\_eventListeners** thread, use **open\(\)** to open a modem node and then create the **g\_reader** thread to read and process messages reported by the modem. +3. In the **g\_eventListeners** thread, use **open\(\)** to open a modem node and then create the **g\_reader** thread to read and process messages reported by the modem. ``` g_fd = open(g_devicePath, O_RDWR); // Open the device node specified by g_devicePath. @@ -57,7 +57,7 @@ The following table describes the API for initializing a modem vendor library. ``` -1. Return the function pointer of the service request API. +4. Return the function pointer of the service request API. ``` // Structure for the service request API of the call module @@ -105,9 +105,9 @@ The following table describes the API for initializing a modem vendor library. ``` -### Debugging and Verification +### Debugging and Verification -1. Use the [hdc\_std](../subsystems/subsys-toolchain-hdc-guide.md#preparations) tool to connect to a debugging device. Then, run the following command to send the generated **libril\_vendor.z.so** library file to the **/system/lib/** directory of the device. For details about how to integrate a library file, see [Integrating Modem Vendor Libraries](#section590mcpsimp). +1. Use the [hdc\_std](../subsystems/subsys-toolchain-hdc-guide.md#how-to-obtain) tool to connect to a debugging device. Then, run the following command to send the generated **libril\_vendor.z.so** library file to the **/system/lib/** directory of the device. For details about how to integrate a library file, see [Integrating Modem Vendor Libraries](#integrating-modem-vendor-libraries). ``` hdc_std file send libril_vendor.z.so /system/lib/ @@ -128,24 +128,24 @@ The following table describes the API for initializing a modem vendor library. ``` -## Responding to Modem Service Requests +## Responding to Modem Service Requests -### When to Use +### When to Use After receiving a specific telephony service request, RIL Adapter calls the target function pointer obtained in modem vendor library initialization to send a specific service request to the vendor library. Then, the vendor library processes the request based on the request ID. -### Available APIs +### Available APIs The following table describes the APIs for responding to modem service requests, with the dial module as an example. **Table 2** APIs for responding to modem service requests -| API | Description | +| API | Description | | -------- | -------- | -| void ReqDial(ReqDataInfo \*requestInfo, const void \*data, size_t dataLen); | Processes number dial requests.
Input parameters:
**requestInfo**: request type
**data**: called number
**dataLen**: data length
Return value: none | -| void (\*OnCallReport)(struct ReportInfo reportInfo, const void \*data, size_t dataLen); | Reports the execution result of a service request to RIL Adapter.
Input parameters:
**reportInfo**: request type
**data**: called number
**dataLen**: data length
Return value: none | +| void ReqDial(ReqDataInfo \*requestInfo, const void \*data, size_t dataLen); | Processes number dial requests.
Input parameters:
**requestInfo**: request type
**data**: called number
**dataLen**: data length
Return value: none | +| void (\*OnCallReport)(struct ReportInfo reportInfo, const void \*data, size_t dataLen); | Reports the execution result of a service request to RIL Adapter.
Input parameters:
**reportInfo**: request type
**data**: called number
**dataLen**: data length
Return value: none | -### How to Develop +### How to Develop 1. Implement processing of dial requests in the **ReqDial\(\)** API. @@ -199,9 +199,9 @@ The following table describes the APIs for responding to modem service requests, ``` -### Debugging and Verification +### Debugging and Verification -1. Use the [hdc\_std](../subsystems/subsys-toolchain-hdc-guide.md#preparations) tool to connect to a debugging device. Then, run the following command to send the generated **libril\_vendor.z.so** library file to the **/system/lib/** directory of the device. +1. Use the [hdc\_std](../subsystems/subsys-toolchain-hdc-guide.md#how-to-obtain) tool to connect to a debugging device. Then, run the following command to send the generated **libril\_vendor.z.so** library file to the **/system/lib/** directory of the device. ``` hdc_std file send libril_vendor.z.so /system/lib/ @@ -242,23 +242,23 @@ The following table describes the APIs for responding to modem service requests, ``` -## Reporting Modem Events +## Reporting Modem Events -### When to Use +### When to Use A modem node thread reads the messages reported by the modem cyclically, parses the messages into specific events, and then reports the events to RIL Adapter. -### Available APIs +### Available APIs The following table describes the API for reporting modem events. **Table 3** API for reporting modem events -| API | Description | +| API | Description | | -------- | -------- | -| void OnNotifyOps(const char \*s, const char \*smsPdu) | Distributes the events reported by the modem.
Input parameters:
**s**: AT command prefix
**smsPdu**: PDU of the SMS message
Return value: none | +| void OnNotifyOps(const char \*s, const char \*smsPdu) | Distributes the events reported by the modem.
Input parameters:
**s**: AT command prefix
**smsPdu**: PDU of the SMS message
Return value: none | -### How to Develop +### How to Develop 1. Call **OnNotifyOps\(\)** in the g\_reader thread of the modem device node to parse reported modem events. On determining the command type, call **OnXxxReport\(\)** to report the parsed module events to the hril layer. @@ -290,7 +290,7 @@ The following table describes the API for reporting modem events. ``` -1. Distribute the reported events from the **hril** layer to the Telephony Service layer. +2. Distribute the reported events from the **hril** layer to the Telephony Service layer. ``` // Report the call status proactively. @@ -316,9 +316,9 @@ The following table describes the API for reporting modem events. ``` -### Debugging and Verification +### Debugging and Verification -1. Use the [hdc\_std](../subsystems/subsys-toolchain-hdc-guide.md#preparations) tool to connect to a debugging device. Then, run the following command to send the generated **libril\_vendor.z.so** library file to the **/system/lib/** directory of the device. +1. Use the [hdc\_std](../subsystems/subsys-toolchain-hdc-guide.md#how-to-obtain) tool to connect to a debugging device. Then, run the following command to send the generated **libril\_vendor.z.so** library file to the **/system/lib/** directory of the device. ``` hdc_std file send libril_vendor.z.so /system/lib/ @@ -370,18 +370,18 @@ The following table describes the API for reporting modem events. ``` -### Development Examples +### Development Examples - **Outgoing Call** The following figure shows the API calling for an outgoing call. **Figure 1** Time sequence of API calling for an outgoing call - +  - When an application initiates an outgoing call, RIL Adapter receives a call request, and the **hril** layer invokes the **ReqDial\(\)** function. In **ReqDial\(\)**, the data passed by the Telephony Service is encapsulated as an AT command and sent to the modem. After executing the dial command, the modem reports the execution result to RIL Adapter through **OnCallReport\(\)**. + When an application initiates an outgoing call, RIL Adapter receives a call request, and the **hril** layer invokes the **ReqDial\(\)** function. In **ReqDial\(\)**, the data passed by the Telephony Service is encapsulated as an AT command and sent to the modem. After executing the dial command, the modem reports the execution result to RIL Adapter through **OnCallReport\(\)**. ``` // Callback function pointer of the call module @@ -456,13 +456,13 @@ The following table describes the API for reporting modem events. The following figure shows the API calling of an incoming call. **Figure 2** Time sequence of API calling for an incoming call - +  - The **g\_reader** thread cyclically reads the messages reported by the modem. When the modem receives an incoming call event, it actively reports the information about the incoming call. + The **g\_reader** thread cyclically reads the messages reported by the modem. When the modem receives an incoming call event, it actively reports the information about the incoming call. - The **g\_reader** thread calls **OnNotifyOps\(\)** to parse the reported information. If the parsed data reported by the modem starts with characters such as **+CRING** or **RING**, it indicates that an incoming call event exists. In this case, the event is reported to RIL Adapter through **OnCallReport\(reportInfo, NULL, 0\)**. + The **g\_reader** thread calls **OnNotifyOps\(\)** to parse the reported information. If the parsed data reported by the modem starts with characters such as **+CRING** or **RING**, it indicates that an incoming call event exists. In this case, the event is reported to RIL Adapter through **OnCallReport\(reportInfo, NULL, 0\)**. ``` // Parse the data reported by the modem as events proactively reported by the corresponding module. @@ -492,11 +492,11 @@ The following table describes the API for reporting modem events. ``` -## Integrating Modem Vendor Libraries +## Integrating Modem Vendor Libraries -### Configuring Compilation Information +### Configuring Compilation Information -Compile the modem vendor library into a dynamic library by using **BUILD.gn**. Upon startup, RIL Adapter loads the dynamic library to the system in dlopen mode and then initializes the library. For details about how to implement vendor library initialization, see [Initializing a Modem Vendor Library](#section211mcpsimp). The following is an example of **BUILD.gn**: +Compile the modem vendor library into a dynamic library by using **BUILD.gn**. Upon startup, RIL Adapter loads the dynamic library to the system in dlopen mode and then initializes the library. For details about how to implement vendor library initialization, see [Initializing a Modem Vendor Library](#initializing-a-modem-vendor-library). The following is an example of **BUILD.gn**: ``` import("//build/ohos.gni") @@ -523,7 +523,7 @@ ohos_shared_library("ril_vendor") { // Modem vendor library } ``` -### Debugging and Verification +### Debugging and Verification 1. Compile the code. 2. Check whether **libril\_vendor.z.so** exists in the **/out/{device_name}/telephony/ril\_adapter** directory. If yes, the integration is successful. Otherwise, correct the error and perform debugging and verification again. diff --git a/en/device-dev/website.md b/en/device-dev/website.md index de8c53fb7d2a4714f6a2d1c3a1077013330eca24..6cfcbb65bcd6cf29218f11a58f8f67667d061f9c 100644 --- a/en/device-dev/website.md +++ b/en/device-dev/website.md @@ -395,6 +395,7 @@ - [Doubly Linked List](kernel/kernel-small-apx-dll.md) - [Bitwise Operation](kernel/kernel-small-apx-bitwise.md) - [Standard Library](kernel/kernel-small-apx-library.md) + - [Kernel Coding Specification](kernel/kernel-mini-appx-code.md) - Kernel for Standard Systems - [Linux Kernel Overview](kernel/kernel-standard-overview.md) - [Applying Patches on OpenHarmony Development Boards](kernel/kernel-standard-patch.md) @@ -450,6 +451,7 @@ - Peripheral Driver Usage - [Audio](driver/driver-peripherals-audio-des.md) - [Camera](driver/driver-peripherals-camera-des.md) + - [Codec](driver/driver-peripherals-codec-des.md) - [Facial Authentication](driver/driver-peripherals-face_auth-des.md) - [Fingerprint Authentication](driver/driver-peripherals-fingerprint_auth-des.md) - [LCD](driver/driver-peripherals-lcd-des.md) @@ -502,21 +504,7 @@ - [Utils Overview](subsystems/subsys-utils-overview.md) - [Utils Development](subsystems/subsys-utils-guide.md) - [Utils FAQ](subsystems/subsys-utils-faqs.md) - - AI Framework - - [AI Engine Framework](subsystems/subsys-aiframework-guide.md) - - [Development Environment](subsystems/subsys-aiframework-envbuild.md) - - Technical Specifications - - [Code Management](subsystems/subsys-aiframework-tech-codemanage.md) - - [Naming](subsystems/subsys-aiframework-tech-name.md) - - [API Development](subsystems/subsys-aiframework-tech-interface.md) - - Development Guidelines - - [SDK](subsystems/subsys-aiframework-devguide-sdk.md) - - [Plug-in](subsystems/subsys-aiframework-devguide-plugin.md) - - [Configuration File](subsystems/subsys-aiframework-devguide-conf.md) - - Development Examples - - [KWS SDK](subsystems/subsys-aiframework-demo-sdk.md) - - [KWS Plug-in](subsystems/subsys-aiframework-demo-plugin.md) - - [KWS Configuration File](subsystems/subsys-aiframework-demo-conf.md) + - [AI Framework Development](subsystems/subsys-ai-aiframework-devguide.md) - Data Management - RDB - [RDB Overview](subsystems/subsys-data-relational-database-overview.md) @@ -547,7 +535,7 @@ - [Development on Application Permission Management](subsystems/subsys-security-rightmanagement.md) - [Development on IPC Authentication](subsystems/subsys-security-communicationverify.md) - [Development on Device Security Level Management](subsystems/subsys-security-devicesecuritylevel.md) - + - [Development on HUKS](subsystems/subsys-security-huks-guide.md) - Startup - [Startup](subsystems/subsys-boot-overview.md) - init Module @@ -561,11 +549,11 @@ - [bootstrap Module](subsystems/subsys-boot-bootstrap.md) - [FAQs](subsystems/subsys-boot-faqs.md) - [Reference](subsystems/subsys-boot-ref.md) - - DFX +- DFX - [DFX](subsystems/subsys-dfx-overview.md) - [HiLog Development](subsystems/subsys-dfx-hilog-rich.md) - [HiLog\_Lite Development](subsystems/subsys-dfx-hilog-lite.md) - - [HiTrace Development](subsystems/subsys-dfx-hitrace.md) + - [HiTraceChain Development](subsystems/subsys-dfx-hitracechain.md) - [HiCollie Development](subsystems/subsys-dfx-hicollie.md) - HiSysEvent Development - [HiSysEvent Logging Configuration](subsystems/subsys-dfx-hisysevent-logging-config.md) @@ -577,7 +565,7 @@ - [HiChecker Development](subsystems/subsys-dfx-hichecker.md) - [FaultLogger Development](subsystems/subsys-dfx-faultlogger.md) - [Hiview Development](subsystems/subsys-dfx-hiview.md) - + - Featured Topics - HPM Part - [HPM Part Overview](hpm-part/hpm-part-about.md) @@ -592,13 +580,6 @@ - WLAN-connected Products - [LED Peripheral Control](guide/device-wlan-led-control.md) - [Third-Party SDK Integration](guide/device-wlan-sdk.md) - - Cameras Without a Screen - - Camera Control - - [Overview](guide/device-iotcamera-control-overview.md) - - Development Guidelines - - [Photographing](guide/device-iotcamera-control-demo-photodevguide.md) - - [Video Recording](guide/device-iotcamera-control-demo-videodevguide.md) - - [Use Case](guide/device-iotcamera-control-example.md) - Cameras with a Screen - Screen and Camera Control - [Overview](guide/device-camera-control-overview.md) @@ -643,11 +624,7 @@ - [Kernel](faqs/faqs-kernel.md) - [Porting](faqs/faqs-porting.md) - [Startup](faqs/faqs-startup.md) - - [System Applications](faqs/faqs-system-applications.md) - - - - + - [System Applications](faqs/faqs-system-applications.md) diff --git a/en/readme/ai.md b/en/readme/ai.md index 2bf316a7650c1767088ad9be877ac5a20f5ccfb1..9115a0024e450acd7a74f151bba0cda4db2c9841 100644 --- a/en/readme/ai.md +++ b/en/readme/ai.md @@ -1,13 +1,13 @@ -# AI +# AI -## Introduction +## Introduction The AI subsystem is the part of OpenHarmony that provides native distributed AI capabilities. At the heart of the subsystem is a unified AI engine framework, which implements quick integration of AI algorithm plug-ins. The framework consists of the plug-in management, module management, and communication management modules, fulfilling lifecycle management and on-demand deployment of AI algorithms. Under this framework, AI algorithm APIs will be standardized to facilitate distributed calling of AI capabilities. In addition, unified inference APIs will be provided to adapt to different inference framework hierarchies. **Figure 1** AI engine framework  -## Directory Structure +## Directory Structure ``` /foundation/ai/engine # Home directory of the AI subsystem @@ -32,7 +32,7 @@ The AI subsystem is the part of OpenHarmony that provides native distributed AI │ │ └── server_executor # Executor of the server module ``` -## Constraints +## Constraints * **Programming language**: C/C++ @@ -40,7 +40,7 @@ The AI subsystem is the part of OpenHarmony that provides native distributed AI * **Others**: The System Ability Manager \(Samgr\) has been started and is running properly. -## Usage +## Usage 1. Compile the AI subsystem. @@ -406,7 +406,7 @@ The AI subsystem is the part of OpenHarmony that provides native distributed AI ``` -## Repositories Involved +## Repositories Involved [AI subsystem](https://gitee.com/openharmony/docs/blob/master/en/readme/ai.md) @@ -420,8 +420,8 @@ Dependency repositories: [startup\_init\_lite](https://gitee.com/openharmony/startup_init_lite/blob/master/README.md) -## Reference +## Reference -[AI Engine Framework Development Guide](https://gitee.com/openharmony/docs/blob/master/en/device-dev/subsystems/subsys-aiframework-guide.md) +[AI Framework Development](https://gitee.com/openharmony/docs/blob/master/en/device-dev/subsystems/subsys-ai-aiframework-devguide.md) diff --git a/en/readme/figures/en-us_image_0000001124735133.png b/en/readme/figures/en-us_image_0000001124735133.png deleted file mode 100644 index c64f96cea56de84488971282f1e3d96b4fa264a6..0000000000000000000000000000000000000000 Binary files a/en/readme/figures/en-us_image_0000001124735133.png and /dev/null differ diff --git a/en/readme/figures/multimedia-service-flow-for-the-small-system.png b/en/readme/figures/multimedia-service-flow-for-the-small-system.png deleted file mode 100755 index 0fac47fbc29296ecdf9078be5e0fa2b6c85617c7..0000000000000000000000000000000000000000 Binary files a/en/readme/figures/multimedia-service-flow-for-the-small-system.png and /dev/null differ diff --git a/en/readme/figures/multimedia-subsystem-architecture.png b/en/readme/figures/multimedia-subsystem-architecture.png deleted file mode 100755 index 356a90cd32d5e48960eb6b02c964b761a8d3b380..0000000000000000000000000000000000000000 Binary files a/en/readme/figures/multimedia-subsystem-architecture.png and /dev/null differ diff --git a/en/readme/startup.md b/en/readme/startup.md index 4d1d1780815533373ea44576ea746c119625d80d..5f12643fffc97c3a896d8fe918dde75a4e9c91a6 100644 --- a/en/readme/startup.md +++ b/en/readme/startup.md @@ -1,6 +1,6 @@ -# Startup +# Startup -## Introduction +## Introduction The startup subsystem is responsible for starting key system processes and services after the kernel is started and before applications are started. The subsystem consists of the following modules: @@ -8,7 +8,7 @@ The startup subsystem is responsible for starting key system processes and servi This module can be used on platforms powered by LiteOS Cortex-A or Linux kernel. - The module starts system service processes from the time the kernel loads the first user-space process to the time the first application is started. In addition to loading key system processes, it needs to configure their permissions during the startup and keep the specified process alive after sub-processes are started. If a key process exits abnormally, the module needs to perform a system restart. For details, see [init Module](../device-dev/subsystems/subsys-boot-init.md). + The module starts system service processes from the time the kernel loads the first user-space process to the time the first application is started. In addition to loading key system processes, it needs to configure their permissions during the startup and keep the specified process alive after sub-processes are started. If a key process exits abnormally, the module needs to perform a system restart. For details, see [init Module](../device-dev/subsystems/subsys-boot-init-cfg.md). - appspawn @@ -27,58 +27,22 @@ The startup subsystem is responsible for starting key system processes and servi This module obtains and sets system attributes. - The module can be used on all platforms. Supported system attributes consist of default, OEM-specified, and custom system attributes. OEM-specified system attributes provide only default values. The specific values need to be adjusted as required. For details, see [syspara Module](../device-dev/subsystems/subsys-boot-syspara.md). + The module can be used on all platforms. Supported system attributes consist of default, OEM-specified, and custom system attributes. OEM-specified system attributes provide only default values. The specific values need to be adjusted as required. For details, see [syspara Module](../device-dev/subsystems/subsys-boot-init-sysparam.md). -## Directory Structure +## Directory Structure **Table 1** Directory structure of the source code for the startup subsystem - - - +## Repositories Involved [Startup subsystem](../device-dev/subsystems/subsys-boot-overview.md) @@ -123,4 +87,4 @@ base/startup/ [startup_init_lite](https://gitee.com/openharmony/startup_init_lite) -[startup\_syspara\_lite](https://gitee.com/openharmony/startup_syspara_lite) +[startup\_syspara\_lite](https://gitee.com/openharmony/startup_syspara_lite) \ No newline at end of file diff --git a/en/release-notes/OpenHarmony-v1-1-4-LTS.md b/en/release-notes/OpenHarmony-v1-1-4-LTS.md index e964014d2bb0c29127a921eb4ce4ee556fd68142..1854f89a4084873937bb7540fbe5afe1484916b4 100644 --- a/en/release-notes/OpenHarmony-v1-1-4-LTS.md +++ b/en/release-notes/OpenHarmony-v1-1-4-LTS.md @@ -77,7 +77,7 @@ For details about the adaptation status, see [SIG-Devboard](https://gitee.com/op | -------- | -------- | | [I4AJEN](https://gitee.com/openharmony/third_party_freetype/issues/I4AJEN) | Fixed the CVE-2020-15999 security vulnerability of the third_party_freetype component.| | [I4AJ6T](https://gitee.com/openharmony/third_party_mbedtls/issues/I4AJ6T) | Fixed the CVE-2020-36475 and CVE-2020-36478 security vulnerabilities of the third_party_mbedtls component.| -| [I4AIYJ](https://gitee.com/openharmony/device_hisilicon_third_party_uboot/issues/I4AIYJ?from=project-issue) | Fixed the CVE-2021-27138 and CVE-2021-27097 security vulnerabilities of the third_party_uboot component.| +| I4AIYJ | Fixed the CVE-2021-27138 and CVE-2021-27097 security vulnerabilities of the third_party_uboot component.| | [I4HUM6](https://gitee.com/openharmony/third_party_lwip/issues/I4HUM6?from=project-issue) | Fixed the CVE-2020-22284 security vulnerability of the third_party_lwip component.| | I4QTVZ | Fixed the CVE-2021-44732 and CVE-2021-45450 security vulnerabilities of the third_party_mbedtls component.| | [I46RRM](https://gitee.com/openharmony/third_party_wpa_supplicant/issues/I46RRM?from=project-issue) | Fixed copying of secondary device types for the P2P group client.| diff --git a/en/release-notes/OpenHarmony-v3.0-LTS.md b/en/release-notes/OpenHarmony-v3.0-LTS.md index a7f029ed5010e3df2f07787e4dfe8b22666ab1b5..131148f4ad92d542b68d70cc2f84edf865383c02 100644 --- a/en/release-notes/OpenHarmony-v3.0-LTS.md +++ b/en/release-notes/OpenHarmony-v3.0-LTS.md @@ -179,6 +179,6 @@ Table 5 Issues resolved for the standard system | [I48IM7](https://gitee.com/openharmony/hiviewdfx_hilog/issues/I48IM7) | During the hilog pressure test, **hilogd** restarts unexpectedly, and the **hilog** command cannot be used.| In the pressure test, there is a low probability that the log output is abnormal. The log output is normal in the commissioning scenario.| October 30| | I48YPH | [DSoftBus - Networking] During the testing of the getting-offline - discovery - networking cycle, there are 3 failures among all the 110 attempts.| There is a low probability that this issue occurs. If a networking failure occurs, initiate the networking again.| October 30| | [I4BVVW](https://gitee.com/openharmony/communication_dsoftbus/issues/I4BVVW) | [DSoftBus - Networking] The success rate of self-networking between a standard-system device and mobile phone is 97%.| There is a low probability that the networking fails.| October 30| -| [I4BXWY](https://gitee.com/openharmony/multimedia_media_standard/issues/I4BXWY) | For Hi3516, noises occur during playback of an audio recording.| This issue occurs only when this development board is used.| October 30| -| [I4BXY1](https://gitee.com/openharmony/multimedia_camera_standard/issues/I4BXY1) | There is no sound in the first few seconds of a video recording, the sound and image are out of sync, frame freezing occurs, and noises occur when the audio source was far away during recording.| This issue occurs only when this development board is used.| October 30| +| I4BXWY | For Hi3516, noises occur during playback of an audio recording.| This issue occurs only when this development board is used.| October 30| +| I4BXY1 | There is no sound in the first few seconds of a video recording, the sound and image are out of sync, frame freezing occurs, and noises occur when the audio source was far away during recording.| This issue occurs only when this development board is used.| October 30| | [3ZJ1D](https://gitee.com/openharmony/kernel_liteos_a/issues/I3ZJ1D) | There is a possibility that the user mode fails in the XTS pressure test of the permission case.| There is a low probability that the UID of a child process fails to be set in the XTS pressure test scenario where child processes are repeatedly created.| October 30| diff --git a/en/release-notes/OpenHarmony-v3.0.1-LTS.md b/en/release-notes/OpenHarmony-v3.0.1-LTS.md index 93c97e5a99e41cfd30bc037c52959b655999d205..afec9959428f2824189e6c83abadf3e8bc134310 100644 --- a/en/release-notes/OpenHarmony-v3.0.1-LTS.md +++ b/en/release-notes/OpenHarmony-v3.0.1-LTS.md @@ -83,27 +83,27 @@ For details about the adaptation status, see [SIG-Devboard](https://gitee.com/op | [I4BJFU](https://gitee.com/openharmony/kernel_liteos_a/issues/I4BJFU) | An error occurs when the dyload_posix module removes a file.| | [I42N33](https://gitee.com/openharmony/third_party_mksh/issues/I42N33) | During the integration test, the Ctrl+C operation does not function after the **cat** command is run. A device restart is required.| | [I4C8BO](https://gitee.com/openharmony/docs/issues/I4C8BO?from=project-issue) | The basic functions of the media subsystem (on a mini- or small-system device) are abnormal when Hi3516D V300 or Hi3518E V300 is burnt and configured by following the instructions in the official website.| -| [I4BWKC](https://gitee.com/openharmony/drivers_framework/issues/I4BWKC) | The camera driver on the Hi3516D V300 board does not function properly in the pressure test.| -| [I4BW0G](https://gitee.com/openharmony/drivers_framework/issues/I4BW0G) | The **ResetDriver** interface of the Hi3516D V300 board fails to be called.| +| I4BWKC | The camera driver on the Hi3516D V300 board does not function properly in the pressure test.| +| I4BW0G | The **ResetDriver** interface of the Hi3516D V300 board fails to be called.| | [I4C7ZK](https://gitee.com/openharmony/multimedia_camera_lite/issues/I4C7ZK) | For Hi3516D V300, the resident memory of the small system exceeds the baseline.| | [I434P1](https://gitee.com/openharmony/multimedia_camera_lite/issues/I434P1) | For Hi3518E V300, the resident memory exceeds the baseline.| | [I48IM7](https://gitee.com/openharmony/hiviewdfx_hilog/issues/I48IM7) | During the HiLog pressure test, the hilogd restarts unexpectedly, and the hilog commands cannot be used.| -| [I4EGMD](https://gitee.com/openharmony/aafwk_aafwk_lite/issues/I4EGMD) | The serialization and deserialization methods of **Want** are defective.| +| I4EGMD | The serialization and deserialization methods of **Want** are defective.| | [I4CED3](https://gitee.com/openharmony/account_os_account/issues/I4CED3) | The JS API returns both "err" and "data" in one message.| -| [I4BXZ1](https://gitee.com/openharmony/app_samples/issues/I4BXZ1) | The **\
callback返回值：亮屏返回true，灭屏返回false。 | +| 错误码ID | 错误信息 | +|---------|---------| +| 4900101 | 连接服务失败。 | **示例：** ```js -power.isScreenOn((error, screenOn) => { - if (typeof error === "undefined") { - console.info('screenOn status is ' + screenOn); - } else { - console.log('error: ' + error); - } -}) +try { + var isActive = power.isActive(); + console.info('power is active: ' + isActive); +} catch(err) { + console.error('check active status failed, err: ' + err); +} ``` +## power.wakeup9+ -## power.isScreenOn +wakeup(detail: string): void -isScreenOn(): Promise<boolean> +唤醒设备。 -检测当前设备的亮灭屏状态。 +**系统接口：** 此接口为系统接口。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core -**返回值：** -| 类型 | 说明 | -| ---------------------- | --------------------------------------- | -| Promise<boolean> | Promise实例，用于异步获取返回值，亮屏返回true，灭屏返回false。 | +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ---------- | +| detail | string | 是 | 唤醒原因。 | + +**错误码：** + +以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 4900101 | 连接服务失败。 | **示例：** ```js -power.isScreenOn() -.then(screenOn => { - console.info('screenOn status is ' + screenOn); -}) -.catch(error => { - console.log('error: ' + error); -}) +try { + power.wakeup('wakeup_test'); +} catch(err) { + console.error('wakeup failed, err: ' + err); +} ``` -## power.wakeupDevice9+ +## power.suspend9+ -wakeupDevice(detail: string): void +suspend(): void -唤醒设备。 +休眠设备。 -此接口为系统接口，三方应用不支持调用。 +**系统接口：** 此接口为系统接口。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core -**参数：** +**错误码：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ---------- | -| detail | string | 是 | 唤醒原因。 | +以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 4900101 | 连接服务失败。 | **示例：** ```js -power.wakeupDevice("application"); -console.info('power_wakeup_device_test success') +try { + power.suspend(); +} catch(err) { + console.error('suspend failed, err: ' + err); +} ``` -## power.suspendDevice9+ +## power.getPowerMode9+ -suspendDevice(): void +getPowerMode(): DevicePowerMode -休眠设备。 +获取当前设备的电源模式。 -此接口为系统接口，三方应用不支持调用。 +**需要权限：** ohos.permission.POWER_OPTIMIZATION **系统能力：** SystemCapability.PowerManager.PowerManager.Core +**返回值：** + +| 类型 | 说明 | +| ------------------------------------ | ---------- | +| [DevicePowerMode](#devicepowermode9) | 电源模式。 | + +**错误码：** + +以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 4900101 | 连接服务失败。 | + **示例：** ```js -power.suspendDevice(); -console.info('power_suspend_device_test success') +try { + var mode = power.getPowerMode(); + console.info('power mode: ' + mode); +} catch(err) { + console.error('get power mode failed, err: ' + err); +} ``` -## power.getPowerMode9+ +## power.setPowerMode9+ + +setPowerMode(mode: DevicePowerMode, callback: AsyncCallback<void>): void -getPowerMode(callback: AsyncCallback<DevicePowerMode>): void +设置当前设备的电源模式。使用callback异步回调。 -获取当前设备的电源模式。 +**系统接口：** 此接口为系统接口。 **需要权限：** ohos.permission.POWER_OPTIMIZATION @@ -169,114 +223,149 @@ getPowerMode(callback: AsyncCallback<DevicePowerMode>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------ | ---- | ------------------------------------------------------------ | -| callback | AsyncCallback<DevicePowerMode> | 是 | 指定的callback回调方法，用于获取返回值。
callback返回值：[DevicePowerMode](#devicepowermode9)。 | +| mode | [DevicePowerMode](#devicepowermode9) | 是 | 电源模式。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置电源模式成功，err为undefined，否则为错误对象。 | + +**错误码：** + +以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 4900101 | 连接服务失败。 | **示例：** ```js -power.getPowerMode((error, mode) => { - if (typeof error === "undefined") { - console.info('power mode is ' + mode); +power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE, err => { + if (typeof err === 'undefined') { + console.info('set power mode to MODE_PERFORMANCE'); } else { - console.log('error: ' + error); + console.error('set power mode failed, err: ' + err); } -}) +}); ``` +## power.setPowerMode9+ -## power.getPowerMode9+ +setPowerMode(mode: DevicePowerMode): Promise<void> -getPowerMode(): Promise<DevicePowerMode> +设置当前设备的电源模式。使用Promise异步回调。 -获取当前设备的电源模式。 +**系统接口：** 此接口为系统接口。 **需要权限：** ohos.permission.POWER_OPTIMIZATION **系统能力：** SystemCapability.PowerManager.PowerManager.Core +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------------------ | ---- | ---------- | +| mode | [DevicePowerMode](#devicepowermode9) | 是 | 电源模式。 | + **返回值：** -| 类型 | 说明 | -| ------------------------------ | ------------------------------------------------------------ | -| Promise<DevicePowerMode> | Promise实例，用于异步获取返回值，[DevicePowerMode](#devicepowermode9)。 | +| 类型 | 说明 | +| ------------------- | -------------------------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | + +**错误码：** + +以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 4900101 | 链接服务失败。 | **示例：** ```js -power.getPowerMode() -.then(mode => { - console.info('power mode is ' + mode); -}) -.catch(error => { - console.log('error: ' + error); +power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE) +.then(() => { + console.info('set power mode to MODE_PERFORMANCE'); }) +.catch(err => { + console.error('set power mode failed, err: ' + err); +}); ``` -## power.setPowerMode9+ +## power.rebootDevice(deprecated) -setPowerMode(mode: DevicePowerMode, callback: AsyncCallback<void>): void +rebootDevice(reason: string): void -设置当前设备的电源模式。 +> 从API version 9开始不再维护，建议使用[power.reboot](#powerreboot9)替代。 -此接口为系统接口，三方应用不支持调用。 +重启设备。 -**需要权限：** ohos.permission.POWER_OPTIMIZATION +**需要权限：** ohos.permission.REBOOT **系统能力：** SystemCapability.PowerManager.PowerManager.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------ | ---- | ------------------------ | -| mode | [DevicePowerMode](#devicepowermode9) | 是 | 电源模式。 | -| callback | AsyncCallback<void> | 是 | 指定的callback回调方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ----- | +| reason | string | 是 | 重启原因。 | **示例：** ```js -power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE, error => { - if (typeof error === "undefined") { - console.info('set power mode to MODE_PERFORMANCE'); - } else { - console.log('error: ' + error); - } -}) +power.rebootDevice('reboot_test'); ``` +## power.isScreenOn(deprecated) -## power.setPowerMode9+ - -setPowerMode(mode: DevicePowerMode): Promise<void> - -设置当前设备的电源模式。 +isScreenOn(callback: AsyncCallback<boolean>): void -此接口为系统接口，三方应用不支持调用。 +> 从API version 9开始不再维护，建议使用[power.isActive](#powerisactive9)替代。 -**需要权限：** ohos.permission.POWER_OPTIMIZATION +检测当前设备的亮灭屏状态。使用callback异步回调。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------------------------------------ | ---- | ---------- | -| mode | [DevicePowerMode](#devicepowermode9) | 是 | 电源模式。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------- | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback<boolean> | 是 | 回调函数。当检测成功，err为undefined，data为获取到的亮灭屏状态，返回true表示梁平，返回false表示灭屏；否则为错误对象。 | -**返回值：** +**示例：** -| 类型 | 说明 | -| ------------------- | ------------- | -| Promise<void> | Promise实例。 | +```js +power.isScreenOn((err, data) => { + if (typeof err === 'undefined') { + console.info('screen on status is ' + data); + } else { + console.error('check screen status failed, err: ' + err); + } +}) +``` + +## power.isScreenOn(deprecated) + +isScreenOn(): Promise<boolean> + +> 从API version 9开始不再维护，建议使用[power.isActive](#powerisactive9)替代。 + +检测当前设备的亮灭屏状态。使用Promise异步回调。 + +**系统能力：** SystemCapability.PowerManager.PowerManager.Core + +**返回值：** +| 类型 | 说明 | +| ---------------------- | -------------------------------------------------- | +| Promise<boolean> | Promise对象。返回true表示亮屏；返回false表示灭屏。 | **示例：** ```js -power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE) -.then(() => { - console.info('set power mode to MODE_PERFORMANCE'); +power.isScreenOn() +.then(data => { + console.info('screen on status is ' + data); }) -.catch(error => { - console.log('error: ' + error); +.catch(err => { + console.error('check screen status failed, err: ' + err); }) ``` @@ -286,7 +375,6 @@ power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE) **系统能力：** SystemCapability.PowerManager.PowerManager.Core - | 名称 | 默认值 | 描述 | | ----------------------- | ------ | ---------------------- | | MODE_NORMAL | 600 | 表示标准模式，默认值。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-prompt.md b/zh-cn/application-dev/reference/apis/js-apis-prompt.md index b757e22f002c9b512580c886f4371ad1a56cbc7f..e27e59cc59adff21df45050006848f3d5824c852 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-prompt.md +++ b/zh-cn/application-dev/reference/apis/js-apis-prompt.md @@ -46,7 +46,7 @@ prompt.showToast({ | 名称 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | -| message | string\| [Resource](../arkui-ts/ts-types.md#resource类型)9+ | 是 | 显示的文本信息。 | +| message | string\| [Resource](../arkui-ts/ts-types.md#resource)9+ | 是 | 显示的文本信息。 | | duration | number | 否 | 默认值1500ms，取值区间：1500ms-10000ms。若小于1500ms则取默认值，若大于10000ms则取上限值10000ms。 | | bottom | string\| number | 否 | 设置弹窗边框距离屏幕底部的位置。 | @@ -147,8 +147,8 @@ prompt.showDialog({ | 名称 | 类型 | 必填 | 说明 | | ------- | ---------------------------------------- | ---- | ---------------------------------------- | -| title | string\| [Resource](../arkui-ts/ts-types.md#resource类型)9+ | 否 | 标题文本。 | -| message | string\| [Resource](../arkui-ts/ts-types.md#resource类型)9+ | 否 | 内容文本。 | +| title | string\| [Resource](../arkui-ts/ts-types.md#resource)9+ | 否 | 标题文本。 | +| message | string\| [Resource](../arkui-ts/ts-types.md#resource)9+ | 否 | 内容文本。 | | buttons | Array | 否 | 对话框中按钮的数组，结构为：{text:'button', color: '\#666666'}，支持1-3个按钮。其中第一个为positiveButton；第二个为negativeButton；第三个为neutralButton。 | ## ShowDialogSuccessResponse @@ -256,7 +256,7 @@ prompt.showActionMenu({ | 名称 | 类型 | 必填 | 说明 | | ------- | ---------------------------------------- | ---- | ---------------------------------------- | -| title | string\| [Resource](../arkui-ts/ts-types.md#resource类型)9+ | 否 | 标题文本。 | +| title | string\| [Resource](../arkui-ts/ts-types.md#resource)9+ | 否 | 标题文本。 | | buttons | Array<[Button](#button)> | 是 | 菜单中菜单项按钮的数组，结构为：{text:'button', color: '\#666666'}，支持1-6个按钮。大于6个按钮时弹窗不显示。 | ## ActionMenuSuccessResponse @@ -277,6 +277,6 @@ prompt.showActionMenu({ | 名称 | 类型 | 必填 | 说明 | | ----- | ---------------------------------------- | ---- | ------- | -| text | string\| [Resource](../arkui-ts/ts-types.md#resource类型)9+ | 是 | 按钮文本内容。 | -| color | string\| [Resource](../arkui-ts/ts-types.md#resource类型)9+ | 是 | 按钮文本颜色。 | +| text | string\| [Resource](../arkui-ts/ts-types.md#resource)9+ | 是 | 按钮文本内容。 | +| color | string\| [Resource](../arkui-ts/ts-types.md#resource)9+ | 是 | 按钮文本颜色。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-runninglock.md b/zh-cn/application-dev/reference/apis/js-apis-runninglock.md index 1b7bfab5917b1be6943cc9e107b386426551161c..a0bde36e929a11bbbedd7cd63e640bf795a45424 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-runninglock.md +++ b/zh-cn/application-dev/reference/apis/js-apis-runninglock.md @@ -1,95 +1,205 @@ -# Runninglock锁 +# RunningLock锁 -该模块主要提供Runninglock锁相关操作的接口，包括创建、查询、持锁、释放锁等操作。 +该模块主要提供RunningLock锁相关操作的接口，包括创建、查询、持锁、释放锁等操作。 >  **说明：** > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - ## 导入模块 -``` +```js import runningLock from '@ohos.runningLock'; ``` +## runningLock.isSupported9+ -## RunningLockType +isSupported(type: RunningLockType): boolean; -RunningLock锁的类型。 +查询系统是否支持该类型的锁。 -**系统能力：** 以下各项对应的系统能力均为SystemCapability.PowerManager.PowerManager.Core +**系统能力：** SystemCapability.PowerManager.PowerManager.Core -| 名称 | 默认值 | 描述 | -| ------------------------ | ---- | ------------------- | -| BACKGROUND | 1 | 阻止系统休眠的锁。 | -| PROXIMITY_SCREEN_CONTROL | 2 | 通过接近或者远离状态来控制亮灭屏的锁。 | +**参数：** +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------------- | ---- | -------------------- | +| type | [RunningLockType](#runninglocktype) | 是 | 需要查询的锁的类型。 | -## isRunningLockTypeSupported +**返回值：** -isRunningLockTypeSupported(type: RunningLockType, callback: AsyncCallback<boolean>): void +| 类型 | 说明 | +| ------- | --------------------------------------- | +| boolean | 返回true表示支持，返回false表示不支持。 | -查询系统是否支持该类型的锁。 +**错误码：** + +以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 4900101 | 连接服务失败。 | + +**示例：** + +```js +try { + var isSupported = runningLock.isSupported(runningLock.RunningLockType.BACKGROUND); + console.info('BACKGROUND type supported: ' + isSupported); +} catch(err) { + console.error('check supported failed, err: ' + err); +} +``` + +## runningLock.create9+ + +createRunningLock(name: string, type: RunningLockType, callback: AsyncCallback<RunningLock>): void + +创建RunningLock锁。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core +**需要权限：** ohos.permission.RUNNING_LOCK + **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------- | ---- | ---------------------------------------- | -| type | RunningLockType | 是 | 需要查询的锁的类型。 | -| callback | AsyncCallback<boolean> | 是 | 指定的callback回调方法，用于获取返回值。
callback返回值：支持返回true，不支持返回false。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------ | ---- | ------------------------------------------------------------ | +| name | string | 是 | 锁的名字。 | +| type | [RunningLockType](#runninglocktype) | 是 | 要创建的锁的类型。 | +| callback | AsyncCallback<[RunningLock](#runninglock)> | 是 | 回调函数。当创建锁成功，err为undefined，data为创建的RunningLock；否则为错误对象。 | + +**错误码：** + +以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)。 + +| 错误码ID | 错误信息 | +|---------|----------| +| 4900101 | 连接服务器失败。 | **示例：** -``` -runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.BACKGROUND, (error, supported) => { - if (typeof error === "undefined") { - console.info('BACKGROUND support status is ' + supported); +```js +runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND, (err, lock) => { + if (typeof err === 'undefined') { + console.info('created running lock: ' + lock); } else { - console.log('error: ' + error); + console.error('create running lock failed, err: ' + err); } +}); +``` + +## runningLock.create9+ + +createRunningLock(name: string, type: RunningLockType): Promise<RunningLock> + +创建RunningLock锁。 + +**系统能力：** SystemCapability.PowerManager.PowerManager.Core + +**需要权限：** ohos.permission.RUNNING_LOCK + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------------- | ---- | ------------------ | +| name | string | 是 | 锁的名字。 | +| type | [RunningLockType](#runninglocktype) | 是 | 要创建的锁的类型。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------------------------------ | ------------------------------------ | +| Promise<[RunningLock](#runninglock)> | Promise对象，返回RunningLock锁对象。 | + +**错误码：** + +以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)。 + +| 错误码ID | 错误信息 | +|---------|----------| +| 4900101 | 连接服务器失败。 | + +**示例：** + +```js +runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + console.info('created running lock: ' + lock); }) +.catch(err => { + console.error('create running lock failed, error: ' + err); +}); ``` +## runningLock.isRunningLockTypeSupported(deprecated) -## isRunningLockTypeSupported +isRunningLockTypeSupported(type: RunningLockType, callback: AsyncCallback<boolean>): void -isRunningLockTypeSupported(type: RunningLockType): Promise<boolean> +> 从API version 9开始不再维护，建议使用[runningLock.isSupported](#runninglockissupported9)替代。 -查询系统是否支持该类型的锁。 +查询系统是否支持该类型的锁。使用callback异步回调。 + +**系统能力：** SystemCapability.PowerManager.PowerManager.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | +| type | [RunningLockType](#runninglocktype) | 是 | 需要查询的锁的类型。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。当查询成功，err为undefined，data为获取到的支持情况，返回true表示支持，返回false表示不支持；否则为错误对象。 | + +**示例：** + +```js +runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.BACKGROUND, (err, data) => { + if (typeof err === 'undefined') { + console.info('BACKGROUND lock support status: ' + data); + } else { + console.log('check BACKGROUND lock support status failed, err: ' + err); + } +}); +``` + +## runningLock.isRunningLockTypeSupported(deprecated) + +isRunningLockTypeSupported(type: RunningLockType): Promise<boolean> + +> 从API version 9开始不再维护，建议使用[runningLock.isSupported](#runninglockissupported9)替代。 + +查询系统是否支持该类型的锁。使用Promise异步回调。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---- | --------------- | ---- | ---------- | -| type | RunningLockType | 是 | 需要查询的锁的类型。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------------- | ---- | -------------------- | +| type | [RunningLockType](#runninglocktype) | 是 | 需要查询的锁的类型。 | **返回值：** -| 类型 | 说明 | -| ---------------------- | ---------------------------------------- | -| Promise<boolean> | Promise实例，用于异步获取返回值，支持返回true，不支持返回false。 | +| 类型 | 说明 | +| ---------------------- | ---------------------------------------------------- | +| Promise<boolean> | Promise对象。返回true表示支持；返回false表示不支持。 | **示例：** -``` -runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.PROXIMITY_SCREEN_CONTROL) -.then(supported => { - console.info('PROXIMITY_SCREEN_CONTROL support status is ' + supported); +```js +runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.BACKGROUND) +.then(data => { + console.info('BACKGROUND lock support status: ' + data); }) -.catch(error => { - console.log('error: ' + error); +.catch(err => { + console.log('check BACKGROUND lock support status failed, err: ' + err); }); ``` - -## createRunningLock +## runningLock.createRunningLock(deprecated) createRunningLock(name: string, type: RunningLockType, callback: AsyncCallback<RunningLock>): void +> 从API version 9开始不再维护，建议使用[runningLock.create](#runninglockcreate9)替代。 + 创建RunningLock锁。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core @@ -98,34 +208,31 @@ createRunningLock(name: string, type: RunningLockType, callback: AsyncCallback&l **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | -------------------------------------- | -| name | string | 是 | 锁的名字。 | -| type | RunningLockType | 是 | 要创建的锁的类型。 | -| callback | AsyncCallback<[RunningLock](#runninglock)> | 是 | 指定的callback回调方法，用于获取返回的RunningLock锁对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------ | ---- | ------------------------------------------------------------ | +| name | string | 是 | 锁的名字。 | +| type | [RunningLockType](#runninglocktype) | 是 | 要创建的锁的类型。 | +| callback | AsyncCallback<[RunningLock](#runninglock)> | 是 | 回调函数。当创建锁成功，err为undefined，data为创建的RunningLock；否则为错误对象。 | **示例：** -``` -runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND, (error, lockIns) => { - if (typeof error === "undefined") { - console.log('create runningLock test error: ' + error); +```js +runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND, (err, lock) => { + if (typeof err === 'undefined') { + console.info('created running lock: ' + lock); } else { - var used = lockIns.isUsed(); - console.info('runninglock is used: ' + used); - lockIns.lock(500); - used = lockIns.isUsed(); - console.info('after lock runninglock is used ' + used); + console.error('create running lock failed, err: ' + err); } -}) +}); ``` - -## createRunningLock +## runningLock.createRunningLock(deprecated) createRunningLock(name: string, type: RunningLockType): Promise<RunningLock> -创建Runninglock锁。 +> 从API version 9开始不再维护，建议使用[runningLock.create](#runninglockcreate9)替代。 + +创建RunningLock锁。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core @@ -133,39 +240,157 @@ createRunningLock(name: string, type: RunningLockType): Promise<RunningLock&g **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---- | --------------- | ---- | --------- | -| name | string | 是 | 锁的名字。 | -| type | RunningLockType | 是 | 要创建的锁的类型。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------------- | ---- | ------------------ | +| name | string | 是 | 锁的名字。 | +| type | [RunningLockType](#runninglocktype) | 是 | 要创建的锁的类型。 | **返回值：** | 类型 | 说明 | -| ---------------------------------------- | ---------------------------------- | -| Promise<[RunningLock](#runninglock)> | Promise实例，用于异步获取返回的RunningLock锁对象。 | +| ------------------------------------------ | ------------------------------------ | +| Promise<[RunningLock](#runninglock)> | Promise对象，返回RunningLock锁对象。 | **示例：** +```js +runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + console.info('created running lock: ' + lock); +}) +.catch(err => { + console.log('create running lock failed, err: ' + err); +}); ``` -runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND) -.then(runninglock => { - console.info('create runningLock success'); + +## RunningLock + +阻止系统休眠的锁。 + +### hold9+ + +hold(timeout: number): void + +锁定和持有RunningLock。 + +**系统能力：** SystemCapability.PowerManager.PowerManager.Core + +**需要权限：** ohos.permission.RUNNING_LOCK + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ----------------------------------------- | +| timeout | number | 否 | 锁定和持有RunningLock的时长，单位：毫秒。 | + +**错误码：** + +以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)。 + +| 错误码ID | 错误信息 | +|---------|----------| +| 4900101 | 连接服务器失败。 | + +**示例：** + +```js +runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + console.info('create running lock success'); + try { + lock.hold(500); + console.info('hold running lock success'); + } catch(err) { + console.error('hold running lock failed, err: ' + err); + } }) -.catch(error => { - console.log('create runningLock test error: ' + error); +.catch(err => { + console.error('create running lock failed, err: ' + err); +}); +``` + +### unhold9+ + +unhold(): void + +释放RunningLock锁。 + +**系统能力：** SystemCapability.PowerManager.PowerManager.Core + +**需要权限：** ohos.permission.RUNNING_LOCK + +**错误码：** + +以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)。 + +| 错误码ID | 错误信息 | +|---------|----------| +| 4900101 | 连接服务器失败。 | + +**示例：** + +```js +runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + console.info('create running lock success'); + try { + lock.unhold(); + console.info('unhold running lock success'); + } catch(err) { + console.error('unhold running lock failed, err: ' + err); + } }) +.catch(err => { + console.error('create running lock failed, err: ' + err); +}); ``` +### isHolding9+ -## RunningLock +isHolding(): boolean -阻止系统休眠的锁。 +查询当前RunningLock是持有状态还是释放状态。 +**系统能力：** SystemCapability.PowerManager.PowerManager.Core -### lock +**返回值：** + +| 类型 | 说明 | +| ------- | ------------------------------------------------------------ | +| boolean | 返回true表示当前RunningLock是持有状态，返回false表示当前RunningLock是释放状态。 | + +**错误码：** + +以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 4900101 | 连接服务失败。 | + +**示例：** + +```js +runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + console.info('create running lock success'); + try { + var isHolding = lock.isHolding(); + console.info('check running lock holding status: ' + isHolding); + } catch(err) { + console.error('check running lock holding status failed, err: ' + err); + } +}) +.catch(err => { + console.error('create running lock failed, err: ' + err); +}); +``` + +### lock(deprecated) lock(timeout: number): void +> 从API version 9开始不再维护，建议使用[RunningLock.hold](#hold9)替代。 + 锁定和持有RunningLock。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core @@ -180,23 +405,24 @@ lock(timeout: number): void **示例：** -``` -runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND) -.then(runningLock => { - runningLock.lock(100) - console.info('create runningLock success') +```js +runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + lock.lock(500); + console.info('create running lock and lock success'); }) -.catch(error => { - console.log('create runningLock test error: ' + error) +.catch(err => { + console.error('create running lock failed, err: ' + err); }); ``` - -### unlock +### unlock(deprecated) unlock(): void -释放Runninglock锁。 +> 从API version 9开始不再维护，建议使用[RunningLock.unhold](#unhold9)替代。 + +释放RunningLock锁。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core @@ -204,40 +430,52 @@ unlock(): void **示例：** -``` -runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND) -.then(runningLock => { - runningLock.unlock() - console.info('create and unLock runningLock success') +```js +runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + lock.unlock(); + console.info('create running lock and unlock success'); }) -.catch(error => { - console.log('create runningLock test error: ' + error) +.catch(err => { + console.error('create running lock failed, err: ' + err); }); ``` - -### isUsed +### isUsed(deprecated) isUsed(): boolean -查询当前Runninglock是持有状态还是释放状态。 +> 从API version 9开始不再维护，建议使用[RunningLock.isHolding](#isholding9)替代。 + +查询当前RunningLock是持有状态还是释放状态。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core **返回值：** -| 类型 | 说明 | -| ------- | ------------------------------------- | -| boolean | 当前RunningLock是持有状态返回true，释放状态返回false。 | +| 类型 | 说明 | +| ------- | ------------------------------------------------------------ | +| boolean | 返回true表示当前RunningLock是持有状态，返回false表示当前RunningLock是释放状态。 | **示例：** -``` -runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND) -.then(runningLock => { - var used = runningLock.isUsed() - console.info('runningLock used status: ' + used) +```js +runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + var isUsed = lock.isUsed(); + console.info('check running lock used status: ' + isUsed); }) -.catch(error => { - console.log('runningLock isUsed test error: ' + error) +.catch(err => { + console.error('check running lock used status failed, err: ' + err); }); ``` + +## RunningLockType + +RunningLock锁的类型。 + +**系统能力：** SystemCapability.PowerManager.PowerManager.Core + +| 名称 | 默认值 | 描述 | +| ------------------------ | ------ | -------------------------------------- | +| BACKGROUND | 1 | 阻止系统休眠的锁。 | +| PROXIMITY_SCREEN_CONTROL | 2 | 通过接近或者远离状态来控制亮灭屏的锁。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-battery.md b/zh-cn/application-dev/reference/apis/js-apis-system-battery.md index 2c4b2dedd6ad05b58909ef2018d0c7abe46743c4..ef6470a146352fde292da777f2061659daed87df 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-battery.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-battery.md @@ -1,9 +1,10 @@ # 电量信息 -> **说明：** -> - 从API Version 6开始，该接口不再维护，推荐使用新接口[`@ohos.batteryInfo`](js-apis-battery-info.md)。 -> -> - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +该模块提供充电状态及剩余电量的查询功能。 + +>  **说明：** +> - 从API Version 6开始不再维护，建议使用[`@ohos.batteryInfo`](js-apis-battery-info.md)替代。 +> - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 @@ -16,7 +17,7 @@ import battery from '@system.battery'; ## battery.getStatus -getStatus(Object): void +getStatus(options?: GetStatusOptions): void; 获取设备当前的充电状态及剩余电量。 @@ -26,29 +27,35 @@ getStatus(Object): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| success | (data: [BatteryResponse](#batteryresponse)) => void | 否 | 接口调用成功的回调函数。| -| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。| -| complete | () => void | 否 | 接口调用结束的回调函数。 | +| options | [GetStatusOptions](#getstatusoptions) | 否 | 包含接口调用结果的对象。 | **示例：** ```js -export default { - getStatus() { - battery.getStatus({ - success: function(data) { - console.log('success get battery level:' + data.level); - }, - fail: function(data, code) { - console.log('fail to get battery level code:' + code + ', data: ' + data); - }, - }); - }, -} +battery.getStatus({ + success: function(data) { + console.log('success get battery level:' + data.level); + }, + fail: function(data, code) { + console.error('fail to get battery level code:' + code + ', data: ' + data); + } +}); ``` +## GetStatusOptions + +包含接口调用结果的对象。 + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------------- | ---- | ------------------------------------------------------------ | +| success | (data: [BatteryResponse](#batteryresponse)) => void | 否 | 接口调用成功的回调函数，data为[BatteryResponse](#batteryresponse)类型的返回值。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。data为错误信息，code为错误码。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | + ## BatteryResponse +包含充电状态及剩余电量的对象。 + | 参数名 | 类型 | 说明 | | -------- | -------- | -------- | | charging | boolean | 当前电池是否在充电中。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-brightness.md b/zh-cn/application-dev/reference/apis/js-apis-system-brightness.md index cf8e51aa4d1b60ca58443507a460b53ae55387bc..206440dd74e9e79918932823829a9030b1c245c8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-brightness.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-brightness.md @@ -1,8 +1,9 @@ # 屏幕亮度 -> **说明：** -> - 从API Version 7 开始，该接口不再维护，推荐使用新接口[`@ohos.brightness`](js-apis-brightness.md)。 -> +该模块提供屏幕亮度和模式的查询、调节接口。 + +>  **说明：** +> - 从API Version 7 开始不再维护，建议使用[`@ohos.brightness`](js-apis-brightness.md)替代。 > - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -16,7 +17,7 @@ import brightness from '@system.brightness'; ## brightness.getValue -getValue(Object): void +getValue(options?: GetBrightnessOptions): void 获得设备当前的屏幕亮度值。 @@ -26,38 +27,25 @@ getValue(Object): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| success | (data: [BrightnessResponse](#brightnessresponse)) => void | 否 | 接口调用成功的回调函数。 | -| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | -| complete | () => void | 否 | 接口调用结束的回调函数。 | - -success返回值： - -| 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| value | number | 屏幕亮度，取值为1-255之间的整数。 | - +| options | [GetBrightnessOptions](#getbrightnessoptions) | 否 | 获取屏幕亮度的参数对象。 | **示例：** ```js - export default { - getValue() { - brightness.getValue({ - success: function(data){ - console.log('success get brightness value:' + data.value); - }, - fail: function(data, code) { - console.log('get brightness fail, code: ' + code + ', data: ' + data); - }, - }); - }, - } + brightness.getValue({ + success: function(data) { + console.log('success get brightness value:' + data.value); + }, + fail: function(data, code) { + console.error('get brightness fail, code: ' + code + ', data: ' + data); + } + }); ``` ## brightness.setValue -setValue(Object): void +etValue(options?: SetBrightnessOptions): void 设置设备当前的屏幕亮度值。 @@ -67,33 +55,26 @@ setValue(Object): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | number | 是 | 屏幕亮度，值为1-255之间的整数。
- 如果值小于等于0，系统按1处理。
- 如果值大于255，系统按255处理。
- 如果值为小数，系统将处理为整数。例如设置为8.1，系统按8处理。 | -| success | () => void | 否 | 接口调用成功的回调函数。 | -| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | -| complete | () => void | 否 | 接口调用结束的回调函数。 | +| options | [SetBrightnessOptions](#setbrightnessoptions) | 否 | 设置屏幕亮度的参数对象。 | **示例：** ```js - export default { - setValue() { - brightness.setValue({ - value: 100, - success: function(){ - console.log('handling set brightness success.'); - }, - fail: function(data, code){ - console.log('handling set brightness value fail, code:' + code + ', data: ' + data); - }, - }); - }, - } + brightness.setValue({ + value: 100, + success: function() { + console.log('handling set brightness success.'); + }, + fail: function(data, code) { + console.error('handling set brightness value fail, code:' + code + ', data: ' + data); + } + }); ``` ## brightness.getMode -getMode(Object): void +getMode(options?: GetBrightnessModeOptions: void 获得当前屏幕亮度模式。 @@ -103,37 +84,25 @@ getMode(Object): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| success | (data: [BrightnessModeResponse](#brightnessmoderesponse)) => void | 否 | 接口调用成功的回调函数。 | -| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | -| complete | () => void | 否 | 接口调用结束的回调函数。 | - -success返回值： - -| 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| mode | number | 值为0或1：
- 0为手动调节屏幕亮度模式
- 1为自动调节屏幕亮度模式 | +| options | [GetBrightnessModeOptions](#getbrightnessmodeoptions) | 否 | 获取屏幕亮度模式的参数对象。 | **示例：** ```js - export default { - getMode() { - brightness.getMode({ - success: function(data){ - console.log('success get mode:' + data.mode); - }, - fail: function(data, code){ - console.log('handling get mode fail, code:' + code + ', data: ' + data); - }, - }); - }, - } + brightness.getMode({ + success: function(data) { + console.log('success get mode:' + data.mode); + }, + fail: function(data, code){ + console.error('handling get mode fail, code:' + code + ', data: ' + data); + } + }); ``` ## brightness.setMode -setMode(Object): void +setMode(options?: SetBrightnessModeOptions): void 设置设备当前的屏幕亮度模式。 @@ -142,74 +111,118 @@ setMode(Object): void **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| mode | number | 是 | 值为0或1
- 0为手动调节屏幕亮度。
- 1为自动调节屏幕亮度。 | -| success | () => void | 否 | 接口调用成功的回调函数。 | -| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | -| complete | () => void | 否 | 接口调用结束的回调函数。 | +| options | [SetBrightnessModeOptions](#setbrightnessmodeoptions) | 否 | 设置屏幕亮度模式的参数对象。 | **示例：** ```js - export default { - setMode() { - brightness.setMode({ - mode: 1, - success: function(){ - console.log('handling set mode success.'); - }, - fail: function(data, code){ - console.log('handling set mode fail, code:' + code + ', data: ' + data); - }, - }); - }, - } + brightness.setMode({ + mode: 1, + success: function() { + console.log('handling set mode success.'); + }, + fail: function(data, code) { + console.error('handling set mode fail, code:' + code + ', data: ' + data); + } + }); ``` ## brightness.setKeepScreenOn -setKeepScreenOn(Object): void +setKeepScreenOn(options?: SetKeepScreenOnOptions): void + +>从API version 7开始不再维护，建议使用[window.setKeepScreenOn](js-apis-window.md#setkeepscreenon)替代。 设置屏幕是否保持常亮状态，开启常亮模式推荐在onShow()阶段调用。 **系统能力：** SystemCapability.PowerManager.DisplayPowerManager **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| keepScreenOn | boolean | 是 | 是否保持屏幕常亮。 | -| success | () => void | 否 | 接口调用成功的回调函数。 | -| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | -| complete | () => void | 否 | 接口调用结束的回调函数。 | +| options | [SetKeepScreenOnOptions](#setkeepscreenonoptions) | 否 | 设置屏幕常亮的参数对象。 | **示例：** ```js - export default { - setKeepScreenOn() { - brightness.setKeepScreenOn({ - keepScreenOn: true, - success: function () { - console.log('handling set keep screen on success.') - }, - fail: function (data, code) { - console.log('handling set keep screen on fail, code:' + code + ', data: ' + data); - }, - }); - }, - } + brightness.setKeepScreenOn({ + keepScreenOn: true, + success: function () { + console.log('handling set keep screen on success.'); + }, + fail: function (data, code) { + console.error('handling set keep screen on fail, code:' + code + ', data: ' + data); + } + }); ``` -## +## GetBrightnessOptions + +获取屏幕亮度的参数对象。 + +| 名称 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ | +| success | (data: [BrightnessResponse](#brightnessresponse)) => void | 否 | 接口调用成功的回调函数。data为[BrightnessResponse](#brightnessresponse)类型的返回值。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。data为错误信息，code为错误码。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | + +## SetBrightnessOptions + +设置屏幕亮度的参数对象。 + +| 名称 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------ | ---- | ------------------------------------------------------------ | +| value | number | 是 | 屏幕亮度，值为1-255之间的整数。
- 如果值小于等于0，系统按1处理。
- 如果值大于255，系统按255处理。
- 如果值为小数，系统将处理为整数。例如设置为8.1，系统按8处理。 | +| success | () => void | 否 | 接口调用成功的回调函数。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。data为错误信息，code为错误码。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | ## BrightnessResponse +包含屏幕亮度的对象。 + | 名称 | 类型 | 说明 | | -------- | -------- | -------- | -| value | number | 屏幕亮度，取值为1-255之间的整数。 | +| value | number | 屏幕亮度，范围：1到255。 | + +## GetBrightnessModeOptions + +获取屏幕亮度模式的参数对象。 + +| 名称 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| success | (data: [BrightnessModeResponse](#brightnessmoderesponse)) => void | 否 | 接口调用成功的回调函数。data为[BrightnessModeResponse](#brightnessmoderesponse)类型的返回值。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。data为错误信息，code为错误码。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | + +## SetBrightnessModeOptions + +设置屏幕亮度模式的参数对象。 + +| 名称 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------ | ---- | ------------------------------------------------------ | +| mode | number | 是 | 0表示手动调节屏幕亮度模式，1表示自动调节屏幕亮度模式。 | +| success | () => void | 否 | 接口调用成功的回调函数。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。data为错误信息，code为错误码。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | ## BrightnessModeResponse +包含屏幕亮度模式的对象。 + | 名称 | 类型 | 说明 | | -------- | -------- | -------- | -| mode | number | 值为0或1。
-0为手动调节屏幕亮度模式。
-1为手动调节屏幕亮度模式。 | +| mode | number | 0表示手动调节屏幕亮度模式，1表示自动调节屏幕亮度模式。 | + +## SetKeepScreenOnOptions + +设置屏幕常亮的参数对象。 + +| 名称 | 类型 | 必填 | 说明 | +| ------------ | ------------------------------------ | ---- | ------------------------------------------------------ | +| keepScreenOn | boolean | 是 | true表示保持屏幕常亮，false表示取消屏幕常亮。 | +| success | () => void | 否 | 接口调用成功的回调函数。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。data为错误信息，code为错误码。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-thermal.md b/zh-cn/application-dev/reference/apis/js-apis-thermal.md index 4c19beee330fb0ca0b0d4653e35fd4514b925131..8ba540f98137c7ae9990fa53bb1f8e9c605e0567 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-thermal.md +++ b/zh-cn/application-dev/reference/apis/js-apis-thermal.md @@ -5,80 +5,169 @@ >  **说明：** > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - ## 导入模块 ```js import thermal from '@ohos.thermal'; ``` +## thermal.registerThermalLevelCallback9+ -## ThermalLevel +registerThermalLevelCallback(callback: Callback<ThermalLevel>): void -热档位信息。 +订阅热档位变化时的回调提醒。 + +**系统能力：** SystemCapability.PowerManager.ThermalManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------- | ---- | ------------------------------ | +| callback | Callback<ThermalLevel> | 是 | 回调函数，返回变化后的热档位。 | + +**错误码：** + +以下错误码的详细介绍请参见[耗电统计错误码](../errorcodes/errorcode-thermal.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 4800101 | 连接服务失败。 | + +**示例：** + +```js +try { + thermal.registerThermalLevelCallback(level => { + console.info('thermal level is: ' + level); + }); + console.info('register thermal level callback success.'); +} catch(err) { + console.error('register thermal level callback failed, err: ' + err); +} +``` + +## thermal.unregisterThermalLevelCallback9+ + +unregisterThermalLevelCallback(callback?: Callback\
AsyncCallback只返回一个参数，为热档位信息，此时可能会产生告警，可通过`// @ts-ignore`进行抑制。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------- | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback<ThermalLevel> | 是 | 回调函数。AsyncCallback只返回一个参数，为热档位信息，此时可能会产生告警，可通过`// @ts-ignore`进行抑制。 | **示例：** ```js -var lev = 0; -thermal.subscribeThermalLevel((lev) => { - console.info("Thermal level is: " + lev); -}) +thermal.subscribeThermalLevel((level) => { + console.info('thermal level is: ' + level); +}); ``` -## thermal.unsubscribeThermalLevel +## thermal.unsubscribeThermalLevel(deprecated) unsubscribeThermalLevel(callback?: AsyncCallback\
@@ -597,15 +690,15 @@ async function demo() { getBoundsCenter(): Promise\
@@ -2729,7 +2729,7 @@ id(id: number): By 指定目标控件id属性，返回By对象自身。 -从API version9开始不再维护，被废弃。 +从API version9开始废弃。 **系统能力**：SystemCapability.Test.UiTest @@ -3051,7 +3051,7 @@ getId(): Promise\
该参数支持[$$](../../ui/ts-syntactic-sugar.md)双向绑定变量。 | +| refreshing | boolean | 是 | 当前组件是否正在刷新。
该参数支持[$$](../../quick-start/arkts-restrictions-and-extensions.md#变量的双向绑定)双向绑定变量。 | | offset | string \| number | 否 | 刷新组件静止时距离父组件顶部的距离。
默认值：16，单位vp | | friction | number \| string | 否 | 下拉摩擦系数，取值范围为0到100。
默认值：62
- 0表示下拉刷新容器不跟随手势下拉而下拉。
- 100表示下拉刷新容器紧紧跟随手势下拉而下拉。
- 数值越大，下拉刷新容器跟随手势下拉的反应越灵敏。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-methods-custom-dialog-box.md b/zh-cn/application-dev/reference/arkui-ts/ts-methods-custom-dialog-box.md index cc257b0dcb26a633ee9116a19c972ac9608a5d34..69dce85187ccc50c4f54e253fe9ce85b5c4fcf77 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-methods-custom-dialog-box.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-methods-custom-dialog-box.md @@ -18,7 +18,7 @@ CustomDialogController(value:{builder: CustomDialog, cancel?: () => void, aut | 参数名 | 参数类型 | 必填 | 参数描述 | | ---------------------- | ---------------------------------------- | ------------------------- | ---------------------- | -| builder | [CustomDialog](../../ui/ts-component-based-customdialog.md) | 是 | 自定义弹窗内容构造器。 | +| builder | [CustomDialog](../../quick-start/arkts-dynamic-ui-elememt-building.md#customdialog) | 是 | 自定义弹窗内容构造器。 | | cancel | () => void | 否 | 点击遮障层退出时的回调。 | | autoCancel | boolean | 否 | 是否允许点击遮障层退出。
默认值：true | | alignment | [DialogAlignment](ts-methods-alert-dialog-box.md#dialogalignment枚举说明) | 否 | 弹窗在竖直方向上的对齐方式。
默认值：DialogAlignment.Default | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-types.md b/zh-cn/application-dev/reference/arkui-ts/ts-types.md index 7909514b3e300b9aac38e4b370ebccf9519df4ae..a55b163537c12541dd54949a685f317c02ea83a8 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-types.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-types.md @@ -213,5 +213,5 @@ | 名称 | 类型定义 | 描述 | | ------------- | ---------------------- | ---------------------------------------- | -| CustomBuilder | () => any | 该方法类型必须使用@Builder装饰器修饰。具体用法见[@Builder](../../ui/ts-component-based-builder.md)。 | +| CustomBuilder | () => any | 该方法类型必须使用@Builder装饰器修饰。具体用法见[@Builder](../../quick-start/arkts-dynamic-ui-elememt-building.md#builder)。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md index 7d90b701c6991739de6f2c745e356a7f6ca3c516..acb3efd2c503f4f5cc370d2e53c651103b38add4 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md @@ -10,7 +10,7 @@ | 名称 | 参数类型 | 描述 | | ---------- | ---------------------------- | ------------------------------------------ | -| visibility | [Visibility](ts-appendix-enums.md#visibility) | 控制当前组件显示或隐藏。注意，即使组件处于隐藏状态，在页面刷新时仍存在重新创建过程，因此当对性能有严格要求时建议使用[条件渲染](../../ui/ts-rending-control-syntax-if-else.md)代替。
默认值：Visibility.Visible| +| visibility | [Visibility](ts-appendix-enums.md#visibility) | 控制当前组件显示或隐藏。注意，即使组件处于隐藏状态，在页面刷新时仍存在重新创建过程，因此当对性能有严格要求时建议使用[条件渲染](../../quick-start/arkts-rendering-control.md#条件渲染)代替。
默认值：Visibility.Visible| ## 示例 diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-accessibility.md b/zh-cn/application-dev/reference/errorcodes/errorcode-accessibility.md new file mode 100644 index 0000000000000000000000000000000000000000..e8674f395457d04a6f8f53f5933be94a9082ae5d --- /dev/null +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-accessibility.md @@ -0,0 +1,96 @@ +# 无障碍子系统错误码 + +## 9300001 输入无效的包名称或者Ability名称 + +**错误信息** + +Invalid bundle name or ability name. + +**错误描述** + +当输入的包名称或者Ability名称无效时，方法将返回该错误码。 + +**可能原因** + +该错误码表示输入无效的包名称或者Ability名称，可能原因如下： +1. 包名称不存在。 +2. 包里面没有对应的Ability。 + +**处理步骤** + +1. 检查包名称是否正确。 +2. 检查包名对应的Ability是否正确。 + +## 9300002 目标Ability已启用 + +**错误信息** + +Target ability already enabled. + +**错误描述** + +当目标Ability已启用时，方法将返回该错误码。 + +**可能原因** + +该错误码表示目标Ability已启用，可能原因是目标Ability已经启用，无法再次启用。 + +**处理步骤** + +1. 停止该目标Ability。 +2. 重新启用该目标Ability。 + +## 9300003 不具备执行该操作的无障碍权限 + +**错误信息** + +Do not have accessibility right for this operation. + +**错误描述** + +当应用执行了用户在启用无障碍扩展应用时没有开启的辅助操作时，方法将返回该错误码。 + +**可能原因** + +该错误码表示应用不具备该操作的无障碍权限，可能原因是应用执行了用户在启用无障碍扩展应用时没有开启的辅助操作。 + +**处理步骤** + +1. 尝试向用户提示请求执行无障碍辅助操作的必要性，并获取用户授权。 +2. 重新启用无障碍扩展应用，并开启所需的辅助操作。 + +## 9300004 属性不存在 + +**错误信息** + +This property does not exist. + +**错误描述** + +当输入无障碍节点元素中不存在的属性时，方法将返回该错误码。 + +**可能原因** + +该错误码表示输入了无效的无障碍节点元素的属性，可能原因是无障碍节点元素中不存在该属性。 + +**处理步骤** + +检查无障碍节点元素中是否存在该属性。 + +## 9300005 不支持该操作 + +**错误信息** + +This action is not supported. + +**错误描述** + +当应用执行无障碍节点元素不支持的操作时，方法将返回该错误码。 + +**可能原因** + +该错误码表示执行了无障碍节点元素不支持的操作，可能原因是无障碍节点元素不支持执行该操作。 + +**处理步骤** + +确认该无障碍节点元素支持的操作列表中是否包含该操作。 \ No newline at end of file diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-batteryStatistics.md b/zh-cn/application-dev/reference/errorcodes/errorcode-batteryStatistics.md new file mode 100644 index 0000000000000000000000000000000000000000..5787950b7a841ffdefa230e42493180dcc68f29f --- /dev/null +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-batteryStatistics.md @@ -0,0 +1,29 @@ +# 耗电统计错误码 + +## 4600101 连接服务失败 + +**错误信息** + +Operation failed. Cannot connect to service. + +**错误描述** + +操作失败，连接系统服务发生异常。 + +**可能原因** + +1. 系统服务停止运行。 + +2. 系统服务内部通讯发生异常。 + +**处理步骤** + +检查系统服务是否正常运行。 + +1. 在控制台中输入如下命令，查看当前的系统服务列表。 + + ```bash + > hdc shell hidumper -ls + ``` + +2. 查看系统服务列表中是否包含BatteryStatisticsService系统服务。 diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-brightness.md b/zh-cn/application-dev/reference/errorcodes/errorcode-brightness.md new file mode 100644 index 0000000000000000000000000000000000000000..b5d83d90fde5bdf977f6afb76f41d1bed9bab4ed --- /dev/null +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-brightness.md @@ -0,0 +1,29 @@ +# 屏幕亮度错误码 + +## 4700101 连接服务失败 + +**错误信息** + +Operation failed. Cannot connect to service. + +**错误描述** + +操作失败，连接系统服务发生异常。 + +**可能原因** + +1. 系统服务停止运行。 + +2. 系统服务内部通讯发生异常。 + +**处理步骤** + +检查系统服务是否正常运行。 + +1. 在控制台中输入如下命令，查看当前的系统服务列表。 + + ```bash + > hdc shell hidumper -ls + ``` + +2. 查看系统服务列表中是否包含DisplayPowerManagerService系统服务。 diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-power.md b/zh-cn/application-dev/reference/errorcodes/errorcode-power.md new file mode 100644 index 0000000000000000000000000000000000000000..235c30c55270902327d319a843c21d7ea250d0a1 --- /dev/null +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-power.md @@ -0,0 +1,47 @@ +# 系统电源管理错误码 + +## 4900101 连接服务失败 + +**错误信息** + +Operation failed. Cannot connect to service. + +**错误描述** + +操作失败，连接系统服务发生异常。 + +**可能原因** + +1. 系统服务停止运行。 + +2. 系统服务内部通讯发生异常。 + +**处理步骤** + +检查系统服务是否正常运行。 + +1. 在控制台中输入如下命令，查看当前的系统服务列表。 + + ```bash + > hdc shell hidumper -ls + ``` + +2. 查看系统服务列表中是否包含PowerManagerService系统服务。 + +## 4900102 正在关机中 + +**错误信息** + +Operation failed. System is shutting down. + +**错误描述** + +操作失败，系统正在关机。 + +**可能原因** + +系统正在处于关机过程中。 + +**处理步骤** + +在系统正常运行的状态下进行操作。 diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-runninglock.md b/zh-cn/application-dev/reference/errorcodes/errorcode-runninglock.md new file mode 100644 index 0000000000000000000000000000000000000000..e346d88ec7d26c3d25e0b935ce1d1007b659cd78 --- /dev/null +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-runninglock.md @@ -0,0 +1,29 @@ +# RunningLock锁错误码 + +## 4900101 连接服务失败 + +**错误信息** + +Operation failed. Cannot connect to service. + +**错误描述** + +操作失败，连接系统服务发生异常。 + +**可能原因** + +1. 系统服务停止运行。 + +2. 系统服务内部通讯发生异常。 + +**处理步骤** + +检查系统服务是否正常运行。 + +1. 在控制台中输入如下命令，查看当前的系统服务列表。 + + ```bash + > hdc shell hidumper -ls + ``` + +2. 查看系统服务列表中是否包含PowerManagerService系统服务。 diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-thermal.md b/zh-cn/application-dev/reference/errorcodes/errorcode-thermal.md new file mode 100644 index 0000000000000000000000000000000000000000..e5665089092a315655ceb517e275147af89776b6 --- /dev/null +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-thermal.md @@ -0,0 +1,29 @@ +# 热管理错误码 + +## 4800101 连接服务失败 + +**错误信息** + +Operation failed. Cannot connect to service. + +**错误描述** + +操作失败，连接系统服务发生异常。 + +**可能原因** + +1. 系统服务停止运行。 + +2. 系统服务内部通讯发生异常。 + +**处理步骤** + +检查系统服务是否正常运行。 + +1. 在控制台中输入如下命令，查看当前的系统服务列表。 + + ```bash + > hdc shell hidumper -ls + ``` + +2. 查看系统服务列表中是否包含ThermalService系统服务。 diff --git a/zh-cn/application-dev/ui/ui-ts-components.md b/zh-cn/application-dev/ui/ui-ts-components.md index 45d22d02d3255dddcd90760c911595a942c2ee17..775cb434d336028df04109f4a1eda38a1d007923 100644 --- a/zh-cn/application-dev/ui/ui-ts-components.md +++ b/zh-cn/application-dev/ui/ui-ts-components.md @@ -5,7 +5,7 @@ ## 组件和装饰器 -在声明式UI中，所有的页面都是由组件构成。组件的数据结构为struct，装饰器[@Component](../ui/ts-component-based-component.md)是组件化的标志。用@Component修饰的struct表示这个结构体有了组件化的能力。 +在声明式UI中，所有的页面都是由组件构成。组件的数据结构为struct，装饰器@Component是组件化的标志。用@Component修饰的struct表示这个结构体有了组件化的能力。 自定义组件的声明方式为： @@ -22,7 +22,7 @@ interface Builder { } ``` -[@Entry](../ui/ts-component-based-entry.md)修饰的Component表示该Component是页面的总入口，也可以理解为页面的根节点。值得注意的是，一个页面有且仅能有一个@Entry，只有被@Entry修饰的组件或者其子组件，才会在页面上显示。 +@Entry修饰的Component表示该Component是页面的总入口，也可以理解为页面的根节点。值得注意的是，一个页面有且仅能有一个@Entry，只有被@Entry修饰的组件或者其子组件，才会在页面上显示。 @Component和@Entry都是基础且十分重要的装饰器。简单地理解，装饰器就是某一种修饰，给被装饰的对象赋予某一种能力，比如@Entry就是页面入口的能力，@Component就是组件化能力。 diff --git a/zh-cn/device-dev/porting/figures/dayu200/dayu200-audio-03.png b/zh-cn/device-dev/porting/figures/dayu200/dayu200-audio-03.png new file mode 100644 index 0000000000000000000000000000000000000000..248ea1854492ca3d2c02fb5a1be1fd5d4ef408a8 Binary files /dev/null and b/zh-cn/device-dev/porting/figures/dayu200/dayu200-audio-03.png differ diff --git a/zh-cn/device-dev/porting/figures/dayu200/dayu200-backlight-01.png b/zh-cn/device-dev/porting/figures/dayu200/dayu200-backlight-01.png new file mode 100644 index 0000000000000000000000000000000000000000..6be451aec844699dc7d254de5c48ce08507a8431 Binary files /dev/null and b/zh-cn/device-dev/porting/figures/dayu200/dayu200-backlight-01.png differ diff --git a/zh-cn/device-dev/porting/figures/dayu200/dayu200-backlight-02.png b/zh-cn/device-dev/porting/figures/dayu200/dayu200-backlight-02.png new file mode 100644 index 0000000000000000000000000000000000000000..062598d4095dbbd7b41c460aa1b09634a3bcb1b2 Binary files /dev/null and b/zh-cn/device-dev/porting/figures/dayu200/dayu200-backlight-02.png differ diff --git a/zh-cn/device-dev/porting/figures/dayu200/dayu200-bt-01.png b/zh-cn/device-dev/porting/figures/dayu200/dayu200-bt-01.png new file mode 100644 index 0000000000000000000000000000000000000000..2bf182464e58219294cb38f36ed652c6391ff2a8 Binary files /dev/null and b/zh-cn/device-dev/porting/figures/dayu200/dayu200-bt-01.png differ diff --git a/zh-cn/device-dev/porting/figures/dayu200/dayu200-camera-01.png b/zh-cn/device-dev/porting/figures/dayu200/dayu200-camera-01.png new file mode 100644 index 0000000000000000000000000000000000000000..1a4fa27e98e5bb4568be1399b57da3b987ee4fbf Binary files /dev/null and b/zh-cn/device-dev/porting/figures/dayu200/dayu200-camera-01.png differ diff --git a/zh-cn/device-dev/porting/figures/dayu200/dayu200-sensor-01.png b/zh-cn/device-dev/porting/figures/dayu200/dayu200-sensor-01.png new file mode 100644 index 0000000000000000000000000000000000000000..3fae6a7aa94e445668e0dd80a1374a04e607f24e Binary files /dev/null and b/zh-cn/device-dev/porting/figures/dayu200/dayu200-sensor-01.png differ diff --git a/zh-cn/device-dev/porting/figures/dayu200/dayu200-tp-01.png b/zh-cn/device-dev/porting/figures/dayu200/dayu200-tp-01.png new file mode 100644 index 0000000000000000000000000000000000000000..83884ab97b8cf678c466da4d1cd71b116d1199a1 Binary files /dev/null and b/zh-cn/device-dev/porting/figures/dayu200/dayu200-tp-01.png differ diff --git a/zh-cn/device-dev/porting/figures/dayu200/dayu200-tp-02.png b/zh-cn/device-dev/porting/figures/dayu200/dayu200-tp-02.png new file mode 100644 index 0000000000000000000000000000000000000000..a9d5ec775f67a0775c38532455d91f3a5b616e58 Binary files /dev/null and b/zh-cn/device-dev/porting/figures/dayu200/dayu200-tp-02.png differ diff --git a/zh-cn/device-dev/porting/figures/dayu200/dayu200-vibrator-01.png b/zh-cn/device-dev/porting/figures/dayu200/dayu200-vibrator-01.png new file mode 100644 index 0000000000000000000000000000000000000000..5527ef2a4b3887eb51a9c9e340a107da5535a425 Binary files /dev/null and b/zh-cn/device-dev/porting/figures/dayu200/dayu200-vibrator-01.png differ diff --git a/zh-cn/device-dev/porting/figures/dayu200/dayu200-wifi-02.png b/zh-cn/device-dev/porting/figures/dayu200/dayu200-wifi-02.png new file mode 100644 index 0000000000000000000000000000000000000000..d150f2aa9c744fdf9ce144ce614be99c88587059 Binary files /dev/null and b/zh-cn/device-dev/porting/figures/dayu200/dayu200-wifi-02.png differ diff --git a/zh-cn/device-dev/porting/figures/dayu200/dayu200-wifi-03.png b/zh-cn/device-dev/porting/figures/dayu200/dayu200-wifi-03.png new file mode 100644 index 0000000000000000000000000000000000000000..24f64af806b6e0f5acb1006a22966bd79d3a8a49 Binary files /dev/null and b/zh-cn/device-dev/porting/figures/dayu200/dayu200-wifi-03.png differ diff --git a/zh-cn/device-dev/porting/porting-dayu200-on_standard-demo.md b/zh-cn/device-dev/porting/porting-dayu200-on_standard-demo.md index 525055339c5e23b7d5d1290ca13a1a0893520ed1..49a9a80a4852e2975095672f55e898fb2ba0ca8b 100755 --- a/zh-cn/device-dev/porting/porting-dayu200-on_standard-demo.md +++ b/zh-cn/device-dev/porting/porting-dayu200-on_standard-demo.md @@ -1,6 +1,6 @@ -**标准系统方案之瑞芯微RK3568移植案例** +# 标准系统方案之瑞芯微RK3568移植案例 - 本文章是基于瑞芯微RK3568芯片的DAYU200开发板，进行标准系统相关功能的移植，主要包括产品配置添加，内核启动、升级，音频ADM化，Camera，TP，LCD，WIFI，BT，vibrator、sensor、图形显示模块的适配案例总结，以及相关功能的适配。 +本文章是基于瑞芯微RK3568芯片的DAYU200开发板，进行标准系统相关功能的移植，主要包括产品配置添加，内核启动、升级，音频ADM化，Camera，TP，LCD，WIFI，BT，vibrator、sensor、图形显示模块的适配案例总结，以及相关功能的适配。 ## 产品配置和目录规划 @@ -212,7 +212,7 @@ init相关配置请参考[启动子系统的规范要求](https://gitee.com/open ADM结构框图如下，Audio Peripheral Drivers和Platform Drivers为平台适配需要完成的工作。 -
+
结合第1步梳理出来的Audio结构分析，Audio Peripheral Drivers包含Rk809的驱动，Platform Drivers包含DMA驱动和I2S驱动。
@@ -1085,7 +1085,7 @@ product.gni中指定了chipset_build_deps camera_device_manager_deps 和 camera_
#### 框架适配介绍
- 
+ 
以V4l2为例，pipeline的连接方式是在HCS配置文件中配置连接，数据源我们称之为SourceNode，主要包括硬件设备的控制、数据流的轮转等。
@@ -1883,7 +1883,8 @@ struct v4l2_buffer {
- InputController：提供input设备的业务控制接口，包括获取器件信息及设备类型、设置电源状态等。
**图 1** INPUT模块HDI接口层框架图
-
+
+
相关目录下源代码目录结构如下所示
@@ -1922,7 +1923,7 @@ tp驱动的适配依赖hdf的input模型，hdf的input模型提供了TP，KEY，
从功能的角度看hdf input模块的框架如下：
-
+
因为hdf input模型的高度抽象集成，TP驱动的适配驱动主要涉及器件驱动层的适配。
@@ -2294,7 +2295,7 @@ device4 :: deviceNode {
基于HDF框架开发的 背光驱动模型
-
+
rk3568背光是通过pwm控制占空比实现的，具体使用的是pwm4
@@ -2398,7 +2399,7 @@ static struct BacklightOps g_blDevOps = {
其实使用的就是HDF PWM 实现的对接内核pwm的接口
-
+
在LCD HDF器件驱动注册背光
@@ -2493,7 +2494,7 @@ HDF WiFi框架总体框架图
#### 驱动模块初始化流程分析
-
+
Ap6275s 是一款SDIO设备WiFi模组驱动，使用标准Linux的SDIO设备驱动。内核模块初始化入口module_init()调用dhd_wifi_platform_load_sdio()函数进行初始化工作，这里调用wifi_platform_set_power()进行GPIO上电，调用dhd_wlan_set_carddetect()进行探测SDIO设备卡，最后调用sdio_register_driver(&bcmsdh_sdmmc_driver);进行SDIO设备驱动的注册，SDIO总线已经检测到WiFi模块设备 根据设备号和厂商号与该设备驱动匹配, 所以立即回调该驱动的bcmsdh_sdmmc_probe()函数，这里进行WiFi模组芯片的初始化工作，最后创建net_device网络接口wlan0，然后注册到Linux内核协议栈中。
@@ -2557,7 +2558,7 @@ HDF WLAN驱动框架由Module、NetDevice、NetBuf、BUS、HAL、Client 和 Mess
代码流程框图如下：
-
+
代码位于device/hihope/rk3568/wifi/bcmdhd_wifi6/hdf_driver_bdh_register.c
@@ -2801,7 +2802,7 @@ p2p-p2p0-0 Link encap:Ethernet HWaddr 12:2c:6b:11:21:e0 Driver bcmsdh_sdmmc
蓝牙整体硬件架构上分为主机（计算机或MCU）和主机控制器（实际蓝牙芯片组）两部分；主机和控制器之间的通信遵循主机控制器接口（HCI），如下所示：
-
+
HCI定义了如何交换命令，事件，异步和同步数据包。异步数据包（ACL）用于数据传输，而同步数据包（SCO）用于带有耳机和免提配置文件的语音。
@@ -3148,7 +3149,7 @@ void hw_process_event(HC_BT_HDR *p_buf)
基于HDF（Hardware Driver Foundation）驱动框架开发的Sensor驱动模型
-
+
rk3568 支持accel sensor，整体的驱动框架openharmony 主线已经具备，只需要实现具体的器件驱动即可。
@@ -3383,7 +3384,7 @@ Vibrator驱动模型主要包含Vibrator（传感器）相关的HDI接口与实
**图 1** Vibrator驱动模型图
-
+
rk3568 支持线性马达，整体的驱动框架openharmony 主线已经具备，只需要实现具体的器件驱动即可。
diff --git a/zh-cn/device-dev/porting/porting-yangfan-on_standard-demo.md b/zh-cn/device-dev/porting/porting-yangfan-on_standard-demo.md
index aaf0a675de0ddd55139c87b5375c55be025e17b9..ee236e2a7d0303f436e419a23536a5d54faf5c92 100644
--- a/zh-cn/device-dev/porting/porting-yangfan-on_standard-demo.md
+++ b/zh-cn/device-dev/porting/porting-yangfan-on_standard-demo.md
@@ -1551,7 +1551,8 @@ struct v4l2_buffer {
- InputController：提供input设备的业务控制接口，包括获取器件信息及设备类型、设置电源状态等。
**图 1** INPUT模块HDI接口层框架图
-
+
+
相关目录下源代码目录结构如下所示
diff --git a/zh-cn/readme/figures/build_framework_ZN.PNG b/zh-cn/readme/figures/build_framework_ZN.PNG
deleted file mode 100644
index 03f4d6f6cffc9d3552f86f197230d01a50e2860e..0000000000000000000000000000000000000000
Binary files a/zh-cn/readme/figures/build_framework_ZN.PNG and /dev/null differ
diff --git "a/zh-cn/readme/\345\220\257\345\212\250\346\201\242\345\244\215\345\255\220\347\263\273\347\273\237.md" "b/zh-cn/readme/\345\220\257\345\212\250\346\201\242\345\244\215\345\255\220\347\263\273\347\273\237.md"
index 60c32bac0ca677738ef065c6031bfc432d2c69e1..2856eb0a36a3206d34b12b6a422aaa1a737f832b 100755
--- "a/zh-cn/readme/\345\220\257\345\212\250\346\201\242\345\244\215\345\255\220\347\263\273\347\273\237.md"
+++ "b/zh-cn/readme/\345\220\257\345\212\250\346\201\242\345\244\215\345\255\220\347\263\273\347\273\237.md"
@@ -1,10 +1,5 @@
# 启动恢复子系统
-- [简介](#section11660541593)
-- [目录](#section161941989596)
-- [约束](#section1718733212019)
-- [使用说明](#section8533192617117)
-- [相关仓](#section1371113476307)
## 简介
@@ -14,7 +9,7 @@
支持使用LiteOS-A和Linux内核的平台。
- 负责处理从内核加载第一个用户态进程开始，到第一个应用程序启动之间的系统服务进程启动过程。启动恢复子系统除负责加载各系统关键进程之外，还需在启动的同时设置其对应权限，并在子进程启动后对指定进程实行保活（若进程意外退出要重新启动），对于核心进程意外退出时，启动恢复子系统还要执行系统重启操作。详见“[init启动引导组件](../device-dev/subsystems/subsys-boot-init.md)”部分。
+ 负责处理从内核加载第一个用户态进程开始，到第一个应用程序启动之间的系统服务进程启动过程。启动恢复子系统除负责加载各系统关键进程之外，还需在启动的同时设置其对应权限，并在子进程启动后对指定进程实行保活（若进程意外退出要重新启动），对于核心进程意外退出时，启动恢复子系统还要执行系统重启操作。详见“[init启动引导组件](../device-dev/subsystems/subsys-boot-init-cfg.md)”部分。
- appspawn应用孵化器组件
@@ -33,7 +28,7 @@
负责提供获取与设置操作系统相关的系统属性。
- 支持全量系统平台。支持的系统属性包括：默认系统属性、OEM厂商系统属性和自定义系统属性。OEM厂商部分仅提供默认值，具体值需OEM产品方按需进行调整，详见“[syspara系统属性组件](../device-dev/subsystems/subsys-boot-syspara.md)”部分。
+ 支持全量系统平台。支持的系统属性包括：默认系统属性、OEM厂商系统属性和自定义系统属性。OEM厂商部分仅提供默认值，具体值需OEM产品方按需进行调整，详见“[syspara系统属性组件](../device-dev/subsystems/subsys-boot-init-sysparam.md)”部分。
## 目录