Jump to content

Template:Boilerplate-UserGuide: Difference between revisions

From SOJI ELECTRONICS
[checked revision][checked revision]
← Older editNewer edit →
Admin (talk | contribs)
Bureaucrats, Interface administrators, Administrators
1,203 edits
VisualWikitext
No edit summary
No edit summary
Line 16: Line 16:


[[Category:Boilerplates]]
[[Category:Boilerplates]]
</noinclude><includeonly>__TOC__
</noinclude><includeonly>
== Safety Information ==
== Safety Information ==


Line 23: Line 23:
=== General Safety ===
=== General Safety ===


''Describe PPE, qualified personnel, working conditions.''
{{Placeholder|e.g., Describe required PPE (safety goggles, gloves), qualified personnel (electrician, technician), and working conditions (well-ventilated, dry, no ignition sources).}}


=== Specific Hazards ===
=== Specific Hazards ===
Line 34: Line 34:
}}
}}


''Add hazard callouts here using {{Danger}}, {{Warning}}, {{Caution}}, {{Notice}} templates.''
{{Placeholder|e.g., Add specific hazard callouts here using {{Danger}}, {{Warning}}, {{Caution}}, {{Notice}} templates. For each hazard: describe the hazard, consequence, and how to avoid.}}


=== Emergency Procedures ===
=== Emergency Procedures ===


''Describe emergency procedures applicable to this product.''
{{Placeholder|e.g., Describe what to do in case of fire, electric shock, chemical exposure, or other product-specific emergencies. Include emergency contact numbers.}}


== Product Overview ==
== Product Overview ==


''Brief description: what the product is, what it does, key value.''
{{Placeholder|e.g., The [Product Name] is a [type] device designed for [primary application]. It features [key technology] and is built for [target environment]. Brief 1–2 paragraph overview of what the product is, what it does, and its key value.}}


=== Intended Use ===
=== Intended Use ===


The product is intended for:
The product is intended for:
* Application 1
* {{Placeholder|e.g., Fuel level monitoring in commercial trucks and fleet vehicles}}
* Application 2
* {{Placeholder|e.g., Backup generator fuel monitoring at telecom sites}}
* Application 3
* {{Placeholder|e.g., Industrial tank monitoring in stationary applications}}


=== NOT Intended For ===
=== NOT Intended For ===


The product is '''not''' intended for:
The product is '''not''' intended for:
* Excluded application 1
* {{Placeholder|e.g., Use in hazardous/explosive atmospheres (use ATEX-rated variant instead)}}
* Excluded application 2
* {{Placeholder|e.g., Submerged or pressurized fluid applications above IP rating}}


=== Product Variants ===
=== Product Variants ===
Line 62: Line 62:
! Variant !! Description !! Use Case
! Variant !! Description !! Use Case
|-
|-
| Variant A || ... || ...
| {{Placeholder|e.g., Standard}} || {{Placeholder|e.g., Cabled version with 2m cable}} || {{Placeholder|e.g., Truck fuel tanks}}
|-
|-
| Variant B || ... || ...
| {{Placeholder|e.g., Extended}} || {{Placeholder|e.g., Cabled version with 5m cable}} || {{Placeholder|e.g., Industrial tanks}}
|}
|}


Line 74: Line 74:
! No. !! Item !! Quantity
! No. !! Item !! Quantity
|-
|-
| 1 || Main product || 01
| 1 || {{Placeholder|e.g., Main sensor unit}} || 01
|-
|-
| 2 || Accessory 1 || 01
| 2 || {{Placeholder|e.g., Mounting bracket kit}} || 01
|-
|-
| 3 || Accessory 2 || 01
| 3 || {{Placeholder|e.g., Connection cable (2m)}} || 01
|-
|-
| 4 || Quick installation guide || 01
| 4 || Quick installation guide || 01
Line 92: Line 92:
! Parameter !! Value !! Unit
! Parameter !! Value !! Unit
|-
|-
| style="text-align:left;" | Dimensions (L × W × H) || ... || mm
| style="text-align:left;" | Dimensions (L × W × H) || {{Placeholder|e.g., 120 × 80 × 35}} || mm
|-
|-
| style="text-align:left;" | Weight || ... || g
| style="text-align:left;" | Weight || {{Placeholder|e.g., 250}} || g
|-
|-
| style="text-align:left;" | Operating temperature || ... || °C
| style="text-align:left;" | Operating temperature || {{Placeholder|e.g., −40 to +85}} || °C
|-
|-
| style="text-align:left;" | Storage temperature || ... || °C
| style="text-align:left;" | Storage temperature || {{Placeholder|e.g., −40 to +85}} || °C
|-
|-
| style="text-align:left;" | Power supply || ... || V / mAh
| style="text-align:left;" | Power supply || {{Placeholder|e.g., 9–32 VDC}} || V
|-
|-
| style="text-align:left;" | Current consumption || ... || µA / mA
| style="text-align:left;" | Current consumption || {{Placeholder|e.g., 25 (avg) / 80 (peak)}} || mA
|-
|-
| style="text-align:left;" | Wireless protocol || ... || —
| style="text-align:left;" | Wireless protocol || {{Placeholder|e.g., Bluetooth 5.0 LE}} || —
|-
|-
| style="text-align:left;" | Ingress protection || ... || IP rating
| style="text-align:left;" | Ingress protection || {{Placeholder|e.g., IP67}} || IP rating
|-
|-
| style="text-align:left;" | Service life (expected) || ... || years
| style="text-align:left;" | Service life (expected) || {{Placeholder|e.g., 5}} || years
|}
|}


Line 114: Line 114:


[[File:Product-dimensions.png|thumb|center|500px|Overall dimensions (mm)]]
[[File:Product-dimensions.png|thumb|center|500px|Overall dimensions (mm)]]
{{Placeholder|e.g., Upload your product dimension drawing as "Product-dimensions.png" via Special:Upload, or replace the File: link above with your actual filename.}}


== Installation ==
== Installation ==
Line 121: Line 123:
=== Tools Required ===
=== Tools Required ===


* Tool 1
* {{Placeholder|e.g., Phillips screwdriver (PH2)}}
* Tool 2
* {{Placeholder|e.g., Adjustable wrench / 13mm spanner}}
* Personal Protective Equipment (PPE): safety goggles, gloves
* Personal Protective Equipment (PPE): safety goggles, gloves


=== Step 1: Site Preparation ===
=== Step 1: Site Preparation ===


''Describe preparation steps before installation.''
{{Placeholder|e.g., Clean the mounting surface. Verify location meets minimum clearance (10 cm around device). Ensure power source is disconnected before starting work.}}


=== Step 2: Mounting ===
=== Step 2: Mounting ===


''Describe mounting procedure.''
{{Placeholder|e.g., Drill 4 mounting holes per the included template. Use M5 bolts to secure the device. Recommended torque: 2.5 N·m.}}


[[File:Product-mounting.png|thumb|center|500px|Mounting diagram]]
[[File:Product-mounting.png|thumb|center|500px|Mounting diagram]]
Line 137: Line 139:
=== Step 3: Connection ===
=== Step 3: Connection ===


''Describe electrical / mechanical / wireless connection.''
{{Placeholder|e.g., Connect red wire to +12V, black to GND. For RS485: yellow to A+, green to B−. Verify polarity before powering on.}}


=== Step 4: Verification ===
=== Step 4: Verification ===


''Describe how to verify successful installation before powering on.''
{{Placeholder|e.g., Apply power. LED should turn green within 5 seconds. Use mobile app to confirm device is discoverable via Bluetooth. Test measurement output.}}


== Configuration ==
== Configuration ==


''How to configure the product after installation.''
{{Placeholder|e.g., This section describes how to configure the product after physical installation. Configuration is done via mobile app (iOS/Android) or USB tool.}}


=== Mobile Application ===
=== Mobile Application ===


Download mobile app:
Download mobile app:
* '''iOS''': App Store — ''[link]''
* '''iOS''': App Store — {{Placeholder|e.g., [https://apps.apple.com/... SOJI Tool on App Store]}}
* '''Android''': Google Play — ''[link]''
* '''Android''': Google Play — {{Placeholder|e.g., [https://play.google.com/... SOJI Tool on Google Play]}}


'''Note''': Grant all permissions requested by the app (Camera, Location, Nearby devices, Bluetooth).
'''Note''': Grant all permissions requested by the app (Camera, Location, Nearby devices, Bluetooth).
Line 164: Line 166:
=== Calibration ===
=== Calibration ===


''Step-by-step calibration procedure.''
{{Placeholder|e.g., Calibration ensures the device reads accurate values. Perform calibration during initial setup and after any major maintenance.}}


==== Step 1: Set Full ====
==== Step 1: Set Full ====


# Action 1
# {{Placeholder|e.g., Fill tank to maximum level}}
# Action 2
# {{Placeholder|e.g., In app: Settings → Calibration → tap "Set Full"}}
# {{Placeholder|e.g., Wait 30 seconds for reading to stabilize, confirm value}}


==== Step 2: Set Empty ====
==== Step 2: Set Empty ====


# Action 1
# {{Placeholder|e.g., Drain tank to minimum level}}
# Action 2
# {{Placeholder|e.g., In app: Settings → Calibration → tap "Set Empty"}}
# {{Placeholder|e.g., Confirm value when reading stabilizes}}


=== Configurable Parameters ===
=== Configurable Parameters ===
Line 181: Line 185:
! Parameter !! Default !! Range / Options !! Description
! Parameter !! Default !! Range / Options !! Description
|-
|-
| Device name || ... || ... || ...
| Device name || {{Placeholder|e.g., LIGO-AIR-001}} || {{Placeholder|e.g., Max 20 chars}} || {{Placeholder|e.g., Bluetooth advertised name}}
|-
|-
| Measurement interval || ... || ... || ...
| Measurement interval || {{Placeholder|e.g., 60 s}} || {{Placeholder|e.g., 1–3600 s}} || {{Placeholder|e.g., How often device measures and broadcasts}}
|-
|-
| Output protocol || ... || ... || ...
| Output protocol || {{Placeholder|e.g., BLE}} || {{Placeholder|e.g., BLE / RS485 / 4–20 mA}} || {{Placeholder|e.g., Communication output format}}
|-
|-
| Password || (default) || ... || '''Must change before deployment'''
| Password || (default) || {{Placeholder|e.g., 6–20 chars}} || '''Must change before deployment'''
|}
|}


== Operation ==
== Operation ==


''Day-to-day usage instructions.''
{{Placeholder|e.g., Day-to-day usage instructions. How operators interact with the product during normal operation.}}


=== Calibration Table ===
=== Calibration Table ===
Line 201: Line 205:
! Method !! Description !! Recommended
! Method !! Description !! Recommended
|-
|-
| Method 1 (Platform) || ... || ✓
| {{Placeholder|e.g., Method 1 (Platform)}} || {{Placeholder|e.g., Calibrate via cloud platform with multi-point reference}} || ✓
|-
|-
| Method 2 (On Device) || ... ||
| {{Placeholder|e.g., Method 2 (On Device)}} || {{Placeholder|e.g., Calibrate directly on device using buttons}} ||
|}
|}


Line 212: Line 216:
* Smartphone with mobile app
* Smartphone with mobile app


''Detailed protocol integration: see [[Product Configuration]].''
{{Placeholder|e.g., For detailed protocol integration, see [[Product Configuration]].}}


=== Long-Range Operation ===
=== Long-Range Operation ===
Line 221: Line 225:
! Combination !! Range
! Combination !! Range
|-
|-
| Standard setup || Standard
| {{Placeholder|e.g., Standard setup}} || {{Placeholder|e.g., Up to 50m line-of-sight}}
|-
|-
| With accessory adapter || 2× Standard
| {{Placeholder|e.g., With high-gain antenna accessory}} || {{Placeholder|e.g., Up to 100m line-of-sight}}
|}
|}


=== Protective Cover ===
=== Protective Cover ===


''Describe optional protective cap / housing installation.''
{{Placeholder|e.g., If using the optional protective cap/housing (P/N XXX), install per the accessory manual. The cap provides additional protection against UV exposure and physical impact.}}


== Troubleshooting ==
== Troubleshooting ==
Line 235: Line 239:
! Symptom !! Possible Cause !! Solution
! Symptom !! Possible Cause !! Solution
|-
|-
| Issue 1 (describe)
| {{Placeholder|e.g., Device does not power on}}
|
|
* Cause 1
* {{Placeholder|e.g., No power supply}}
* Cause 2
* {{Placeholder|e.g., Reverse polarity wiring}}
|
|
* Solution 1
* {{Placeholder|e.g., Verify voltage with multimeter (9–32 VDC required)}}
* Solution 2
* {{Placeholder|e.g., Check wire colors per Installation Step 3}}
|-
|-
| Issue 2 (describe)
| {{Placeholder|e.g., No Bluetooth connection}}
|
|
* Cause
* {{Placeholder|e.g., Device out of range}}
* {{Placeholder|e.g., Bluetooth disabled on phone}}
|
|
* Solution
* {{Placeholder|e.g., Move closer (<10 m)}}
* {{Placeholder|e.g., Enable Bluetooth + Location permissions}}
|-
|-
| Issue 3 (describe)
| {{Placeholder|e.g., Incorrect readings}}
|
|
* Cause
* {{Placeholder|e.g., Calibration drift over time}}
|
|
* Solution
* {{Placeholder|e.g., Re-run calibration procedure}}
|}
|}


Line 265: Line 271:
! Frequency !! Action
! Frequency !! Action
|-
|-
| Monthly       || ''Describe monthly checks''
| Monthly         || {{Placeholder|e.g., Visual inspection for physical damage, check mounting torque}}
|-
|-
| Quarterly     || ''Describe quarterly checks''
| Quarterly       || {{Placeholder|e.g., Clean external surface, verify LED indicator}}
|-
|-
| Annually       || ''Describe annual maintenance''
| Annually         || {{Placeholder|e.g., Verify calibration with reference, check cable integrity}}
|-
|-
| Every 5 years || ''Describe 5-year inspection''
| Every 5 years   || {{Placeholder|e.g., Full functional test, re-calibrate}}
|-
|-
| Every 8-10 years || ''Battery / major replacement''
| Every 8–10 years || {{Placeholder|e.g., Battery replacement (if battery-powered)}}
|}
|}


Line 287: Line 293:
=== Battery Replacement ===
=== Battery Replacement ===


''If applicable: battery replacement procedure with safety warnings.''
{{Placeholder|e.g., If battery-powered: describe battery replacement procedure. Include battery part number, replacement interval, and required torque for housing screws.}}


{{Warning
{{Warning
Line 335: Line 341:
| WEEE (2012/19/EU)              || Registered
| WEEE (2012/19/EU)              || Registered
|-
|-
| Battery WEEE (2006/66/EC)      || ''(if applicable)''
| Battery WEEE (2006/66/EC)      || {{Placeholder|e.g., Registered (if applicable)}}
|}
|}


Line 343: Line 349:
! Standard !! Rating
! Standard !! Rating
|-
|-
| IEC 60529 (Ingress Protection) || ...
| IEC 60529 (Ingress Protection) || {{Placeholder|e.g., IP67}}
|}
|}


=== Bluetooth Qualification ===
=== Bluetooth Qualification ===


''(If product uses Bluetooth)''
{{Placeholder|e.g., If product uses Bluetooth, list QDID, Member ID, and EPDID below. Remove this section if not applicable.}}


* Bluetooth Core Specification: ...
* Bluetooth Core Specification: {{Placeholder|e.g., 5.0}}
* Bluetooth SIG Member ID: ''(see [[Product Memberships]])''
* Bluetooth SIG Member ID: {{Placeholder|e.g., see [[Product Memberships]]}}
* End Product Declaration ID: ''(see [[Product Memberships]])''
* End Product Declaration ID: {{Placeholder|e.g., D012345}}


''Detailed certification information: see [[Product Certification & Approvals]]''
''Detailed certification information: see [[Product Certification & Approvals]]''
Line 359: Line 365:
=== Warranty ===
=== Warranty ===


* '''Warranty period''': ... years from date of shipment
* '''Warranty period''': {{Placeholder|e.g., 2}} years from date of shipment
* '''NOT covered''': battery, physical damage, unauthorized modification
* '''NOT covered''': battery, physical damage, unauthorized modification
* '''Warranty void if''':
* '''Warranty void if''':
Line 376: Line 382:
| Email  || support@sojielectronics.com
| Email  || support@sojielectronics.com
|-
|-
| Phone  || ''(insert support number)''
| Phone  || {{Placeholder|e.g., +84 ... (insert support number)}}
|-
|-
| Address || ''(insert SOJI Electronics JSC address)''
| Address || {{Placeholder|e.g., SOJI Electronics JSC, [insert full address]}}
|}
|}


Line 388: Line 394:
| This User Guide || 1.0 || {{subst:#time:d/m/Y}}
| This User Guide || 1.0 || {{subst:#time:d/m/Y}}
|-
|-
| Datasheet || ... || ...
| Datasheet || {{Placeholder|e.g., 1.2}} || {{Placeholder|e.g., 01/05/2026}}
|-
|-
| Configuration Guide || ... || ...
| Configuration Guide || {{Placeholder|e.g., 1.0}} || {{Placeholder|e.g., 15/04/2026}}
|-
|-
| Protocol Integration || ... || ...
| Protocol Integration || {{Placeholder|e.g., 1.1}} || {{Placeholder|e.g., 20/04/2026}}
|}
|}


Revision as of 08:57, 15 May 2026

This boilerplate creates a User Guide page structure following IEC/IEEE 82079-1.

11 sections:

  1. Safety Information
  2. Product Overview
  3. Package Contents
  4. Specifications
  5. Installation
  6. Configuration
  7. Operation
  8. Troubleshooting
  9. Maintenance
  10. Certification / Compliance
  11. Support / Contact
SOJI Electronics
Retrieved from "https://wiki.sojielectronics.com/index.php?title=Template:Boilerplate-UserGuide&oldid=672"