<p>George Joseph has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/18360">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">res_geolocation:  Add initial markdown for Geolocation wiki pages<br><br>This is incomplete but I wanted to get them into Gerrit<br>since I'm going to be offline for a bit.<br><br>Change-Id: I85b239776209bff3fc3388cf9b0a322a1764db29<br>---<br>A res/res_geolocation/wiki/AsteriskImplementation.md<br>A res/res_geolocation/wiki/CivicAddress.md<br>A res/res_geolocation/wiki/GML.md<br>A res/res_geolocation/wiki/Geolocation.md<br>A res/res_geolocation/wiki/LocationConcepts.md<br>A res/res_geolocation/wiki/URI.md<br>6 files changed, 280 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/60/18360/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/res/res_geolocation/wiki/AsteriskImplementation.md b/res/res_geolocation/wiki/AsteriskImplementation.md</span><br><span>new file mode 100644</span><br><span>index 0000000..6c6a2b3</span><br><span>--- /dev/null</span><br><span>+++ b/res/res_geolocation/wiki/AsteriskImplementation.md</span><br><span>@@ -0,0 +1,153 @@</span><br><span style="color: hsl(120, 100%, 40%);">+{toc}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h1. Core Configuration</span><br><span style="color: hsl(120, 100%, 40%);">+The bulk of the geolocation support is implemented in the res_geolocation module and configured in the geolocation.conf file.  The file contains two main objects, Location and Profile.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h2. Common Behavior</span><br><span style="color: hsl(120, 100%, 40%);">+Some of the parameters in each object are actually lists of comma-separated name-value "sub-parameters".   For example, the {{location_info}} parameter in the Location object contains a list of sub-parameters that are specific to the location type.</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+location_info = shape=Circle, pos="39.12345 -105.98766", radius=100</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+You must double quote sub-parameter values with spaces in them and spaces around the ","s or "="s are ignored.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+For readability, parameters that use sub-parameters can be split over more than one line.  For example:</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+location_info = country=US,A1="New York",A3="New York"</span><br><span style="color: hsl(120, 100%, 40%);">+location_info = house_number=1633,PRD=W,street=46th,</span><br><span style="color: hsl(120, 100%, 40%);">+location_info = street_suffix = Street,postal_code=10222</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+would be equivalent to:</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+location_info = country=US,A1="New York",A3="New York",house_number=1633,PRD=W,street=46th,street_suffix = Street,postal_code=10222</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Some of the parameters can contain references to channel variables and dialplan functions.  For example, you might have a URI location object that contains a reference to the {{EXTEN}} channel variable:</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+location_info = URI=http://some.example.com?key=${EXTEN}</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+When a call is processed that uses this location object, {{$\{EXTEN\}}} would be replaced with the channel's extension and would result in a URI such as {{http://some.example.com?key=1000}}.  You'd set up your web server to return a location document based on the value of "key".</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h2. Location</span><br><span style="color: hsl(120, 100%, 40%);">+The Location object defines a discrete location or defines a template that can be used to define a discrete location on a per-call basis.</span><br><span style="color: hsl(120, 100%, 40%);">+||Parameter||Required?||Uses Channel\\Variables?||Uses Sub\\Parameters?||Usage||</span><br><span style="color: hsl(120, 100%, 40%);">+|type|yes|no|no|Must be "location"|</span><br><span style="color: hsl(120, 100%, 40%);">+|format|yes|no|no|"civicAddress", "GML" or "URI" to indicate how the location is expressed.|</span><br><span style="color: hsl(120, 100%, 40%);">+|method|no|no|no|If provided, it MUST be one of "GPS", "A-GPS", "Manual", "DHCP", "Triangulation", "Cell", "802.11"|</span><br><span style="color: hsl(120, 100%, 40%);">+|location_source|no|no|no|If provided, it MUST be a fully qualified domain name.  IP addresses are specifically not allowed.</span><br><span style="color: hsl(120, 100%, 40%);">+See [RFC8787|Geolocation#rfc8787] for the exact definition of this parameter.|</span><br><span style="color: hsl(120, 100%, 40%);">+|confidence|no|no|yes|Sub-parameters:</span><br><span style="color: hsl(120, 100%, 40%);">+* {{value}}: A percentage indicating the confidence or "unknown".</span><br><span style="color: hsl(120, 100%, 40%);">+* {{pdf}}: "unknown", "normal" or "rectangular"</span><br><span style="color: hsl(120, 100%, 40%);">+Example: {{confidence = value=80, pdf=unknown}}</span><br><span style="color: hsl(120, 100%, 40%);">+If no {{confidence}} parameter is specified, the default is 95%.</span><br><span style="color: hsl(120, 100%, 40%);">+See [RFC7459|Geolocation#rfc7459] for the exact definition of this parameter.|</span><br><span style="color: hsl(120, 100%, 40%);">+|location_info|yes|yes|yes|The sub-parameters of location_info are dependent on the location's format:</span><br><span style="color: hsl(120, 100%, 40%);">+* URI: A single {{URI}} sub-parameter with the URI.</span><br><span style="color: hsl(120, 100%, 40%);">+Example: {{location_info = URI=http://some.example.com}}</span><br><span style="color: hsl(120, 100%, 40%);">+\\</span><br><span style="color: hsl(120, 100%, 40%);">+* civicAddress: A set of sub-parameters that describe the location.</span><br><span style="color: hsl(120, 100%, 40%);">+Example: {{location_info = country=US,A1="New York",A3="New York",house_number=1633,PRD=W,street=46th,street_suffix = Street,postal_code=10222}}</span><br><span style="color: hsl(120, 100%, 40%);">+See the [Civic Address] page for more info.</span><br><span style="color: hsl(120, 100%, 40%);">+\\</span><br><span style="color: hsl(120, 100%, 40%);">+* GML: A set of sub-parameters that describe the location.</span><br><span style="color: hsl(120, 100%, 40%);">+Example: {{location_info = shape=Circle, pos="39.12345 -105.98766", radius=100}}</span><br><span style="color: hsl(120, 100%, 40%);">+See the [GML] page for more info.</span><br><span style="color: hsl(120, 100%, 40%);">+|</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h2. Profile</span><br><span style="color: hsl(120, 100%, 40%);">+The Profile object defines how a location is used and is referenced by channel drivers.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+||Parameter||Required?||Uses Channel\\Variables?||Uses Sub\\Parameters?||Usage||</span><br><span style="color: hsl(120, 100%, 40%);">+|type|yes|no|no|Must be "profile"|</span><br><span style="color: hsl(120, 100%, 40%);">+|location_reference|no|no|no|Specifies the id of a Location object to use.|</span><br><span style="color: hsl(120, 100%, 40%);">+|pidf_element|no|no|no|For Civic Address and GML location formats, this parameter specifies the PIDF element that will carry the location description on outgoing SIP requests.  Must be one of "tuple", "device" or "person".  The default is "device".|</span><br><span style="color: hsl(120, 100%, 40%);">+|allow_routing|no|no|no|This value controls the value of the {{Geolocation-Routing}} header sent on SIP requests,  Must be "yes" or "no".  The default is "no".</span><br><span style="color: hsl(120, 100%, 40%);">+See [RFC6442|Geolocation#rfc6442] for more informatrion.|</span><br><span style="color: hsl(120, 100%, 40%);">+|action|no|no|no|Specifies what should be done with any incoming location descriptions received by a channel referencing this profile.\\</span><br><span style="color: hsl(120, 100%, 40%);">+* {{discard}}: Discard any incoming location descriptions and use only the location description specified by {{location_reference}} (if any).\\</span><br><span style="color: hsl(120, 100%, 40%);">+* {{append}}: Append any incoming location descriptions to the one specified by {{location_reference}} (if any).\\</span><br><span style="color: hsl(120, 100%, 40%);">+* {{prepend}}: Prepend any incoming location descriptions to the one specified by {{location_reference}} (if any).\\</span><br><span style="color: hsl(120, 100%, 40%);">+* {{replace}}: Replace the location description specified by {{location_reference}} (if any) with the ones received.\\</span><br><span style="color: hsl(120, 100%, 40%);">+*WARNING*: Using the {{append}} or {{prepend}} options can cause _multiple_ location objects to be sent to a recipient. [RFC5491|Geolocation#rfc5491] discourages the use of multiple location objects but has rules that should be followed if it's necessary.  Unfortunately, as is typical for RFCs, there are many "SHOULD"s and very few "MUST"s in the rules so you should read that RFC carefully before you allow multiple locations.</span><br><span style="color: hsl(120, 100%, 40%);">+|</span><br><span style="color: hsl(120, 100%, 40%);">+|usage_rules|no|yes|yes|For Civic Address and GML location formats, this parameter specifies the contents of the {{usage-rules}} PIDF-LO element.\\</span><br><span style="color: hsl(120, 100%, 40%);">+* {{retransmission-allowed}}: Must be "yes" or "no".  The default is "no".\\</span><br><span style="color: hsl(120, 100%, 40%);">+* {{retention-expires}}: An ISO-format timestamp after which the recipient MUST discard and location information associated with this request.  The default is 24 hours after the request was sent.  You can use dialplan functions to create a timestamp yourself if needed.  For example, to set the timestamp to 1 hour after the request is sent, use:</span><br><span style="color: hsl(120, 100%, 40%);">+{{retention-expires="$\{STRFTIME($[$\{EPOCH\}+3600],UTC,%FT%TZ)\}"}}\\</span><br><span style="color: hsl(120, 100%, 40%);">+See [RFC4119|Geolocation#rfc4119] for the exact definition of this parameter.</span><br><span style="color: hsl(120, 100%, 40%);">+|</span><br><span style="color: hsl(120, 100%, 40%);">+|location_refinement|no|yes|yes|This parameter can be used to refine referenced location by adding these sub-parameters to the {{location_info}} parameter of the referenced location object.  For example, you could have Civic Address referenced object describe a building, then have this profile refine it by adding floor, room, etc.  Another profile could then also reference the same location object and refine it by adding a different floor, room, etc.</span><br><span style="color: hsl(120, 100%, 40%);">+|location_variables|no|yes|yes|Any parameter than can use channel variables can also arbitrary variables defined in this parameter.  For example {{location_variables = MYVAR1=something, MYVAR2="something else"}} would allow you to use {{$\{MYVAR1\}}} and {{$\{MYVAR2\}}} in any pof those parameters|</span><br><span style="color: hsl(120, 100%, 40%);">+|notes|no|no|no|The specifications allow a free-form "note-well" element to be added to the location description.  Any text entered here will be present on all outgoing Civic Address and GML requests.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h1. chan_pjsip Configuration</span><br><span style="color: hsl(120, 100%, 40%);">+Two new parameters have been added to pjsip endpoints:</span><br><span style="color: hsl(120, 100%, 40%);">+||Parameter||Usage||</span><br><span style="color: hsl(120, 100%, 40%);">+|geoloc_incoming_call_profile|Should be set to the name of a geolocation profile to use for calls coming into Asterisk from this remote endpoint.  If not set, no geolocation processing will occur and any location descriptions present on the incoming request will be silently dropped.|</span><br><span style="color: hsl(120, 100%, 40%);">+|geoloc_outgoing_call_profile|Should be set to the name of a geolocation profile to use for calls Asterisk sends to this remote endpoint.  If not set, no geolocation processing will occur and any location descriptions coming from the associated incoming channel or the dialplan will be silently dropped.|</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h1. Dialplan Functions</span><br><span style="color: hsl(120, 100%, 40%);">+Two new dialplan applications and one dialplan function have been adedd to allow a dialplan author to manipulate </span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h2. GeolocProfileCreate</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h2. GeolocProfileDelete</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h2. GEOLOC_PROFILE</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h1. Call Flow</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h2. Simple Example 1</span><br><span style="color: hsl(120, 100%, 40%);">+Alice and Bob work in the same building so in geolocation.conf, we can define a location that descibes the building and profiles for Bob and Alice that add floor and room.  We're assuming here that Bob's and Alice's phones don't send any location information themselves.</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+[building1]</span><br><span style="color: hsl(120, 100%, 40%);">+type = location</span><br><span style="color: hsl(120, 100%, 40%);">+format = civicAddress</span><br><span style="color: hsl(120, 100%, 40%);">+location_info = country=US, A1="New York", A3="New York",</span><br><span style="color: hsl(120, 100%, 40%);">+location_info = HNO=1633, PRD=W, RD=46th, STS=Street, PC=10222</span><br><span style="color: hsl(120, 100%, 40%);">+method = Manual</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+[alice]</span><br><span style="color: hsl(120, 100%, 40%);">+type = profile</span><br><span style="color: hsl(120, 100%, 40%);">+location_reference = building1</span><br><span style="color: hsl(120, 100%, 40%);">+location_refinement = FLR=4, ROOM=4B20</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+[bob]</span><br><span style="color: hsl(120, 100%, 40%);">+type = profile</span><br><span style="color: hsl(120, 100%, 40%);">+location_reference = building1</span><br><span style="color: hsl(120, 100%, 40%);">+location_refinement = FLR=32, ROOM=32A6</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+In pjsip.conf, we can now associate those profiles to endpoints.</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+[bob]</span><br><span style="color: hsl(120, 100%, 40%);">+type = endpoint</span><br><span style="color: hsl(120, 100%, 40%);">+geoloc_incoming_call_profile = bob</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+[alice]</span><br><span style="color: hsl(120, 100%, 40%);">+type = endpoint</span><br><span style="color: hsl(120, 100%, 40%);">+geoloc_incoming_call_profile = alice</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+You'll notice that neither bob nor alice set {{geoloc_outging_call_profile}} because we never want to send location information _to_ them.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Now when Alice makes a call, Asterisk will construct an effective profile (including any defaults and variable substitutions) that looks like this..</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+format = civicAddress</span><br><span style="color: hsl(120, 100%, 40%);">+location_info = country=US, A1="New York", A3="New York",</span><br><span style="color: hsl(120, 100%, 40%);">+location_info = HNO=1633, RD=46th, STS=Street, PC=10222, FLR=4, ROOM=4B20</span><br><span style="color: hsl(120, 100%, 40%);">+method = Manual</span><br><span style="color: hsl(120, 100%, 40%);">+usage_rules = retransmission-allowed=no, retention-expires="${STRFTIME($[${EPOCH}+86400],UTC,%FT%TZ)}"</span><br><span style="color: hsl(120, 100%, 40%);">+allow_routing = no</span><br><span style="color: hsl(120, 100%, 40%);">+pidf_element = device</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Bob's effective profile would exactly the same except for {{FLR}} and {{ROOM}}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+This effective profile will then be forwarded to the dialplan.  The dialplan application can then use GEOLOC_PROFILE to make changes before the effective profile is forwarded to the outgoing channel.  It can also use GeolocProfileDelete to just delete the effective profile and pass nothing.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span>diff --git a/res/res_geolocation/wiki/CivicAddress.md b/res/res_geolocation/wiki/CivicAddress.md</span><br><span>new file mode 100644</span><br><span>index 0000000..84680bb</span><br><span>--- /dev/null</span><br><span>+++ b/res/res_geolocation/wiki/CivicAddress.md</span><br><span>@@ -0,0 +1,78 @@</span><br><span style="color: hsl(120, 100%, 40%);">+{toc}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h1. Civic Address Codes</span><br><span style="color: hsl(120, 100%, 40%);">+The following tables list the IANA registered element names that are</span><br><span style="color: hsl(120, 100%, 40%);">+currently accepted. The complete list of codes is defined in:</span><br><span style="color: hsl(120, 100%, 40%);">+[https://www.iana.org/assignments/civic-address-types-registry/civic-address-types-registry.xhtml]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+These codes were originally defined in [RFC4119|Geolocation#rfc4119] and [RFC4776|Geolocation#rfc4776]</span><br><span style="color: hsl(120, 100%, 40%);">+|| Label || Description || Example |</span><br><span style="color: hsl(120, 100%, 40%);">+| country | The country is identified by the two-letter ISO 3166 code.|US|</span><br><span style="color: hsl(120, 100%, 40%);">+| A1 | national subdivisions (state, region, province, prefecture)|New York|</span><br><span style="color: hsl(120, 100%, 40%);">+| A2 | county, parish, gun (JP), district (IN)|King's County|</span><br><span style="color: hsl(120, 100%, 40%);">+| A3 | city, township, shi (JP)|New York|</span><br><span style="color: hsl(120, 100%, 40%);">+| A4 | city division, borough, city, district, ward, chou (JP)|Manhattan|</span><br><span style="color: hsl(120, 100%, 40%);">+| A5 | neighborhood, block | Morningside Heights |</span><br><span style="color: hsl(120, 100%, 40%);">+| A6 | street\\NOTE: This code has been deprecated in favor of {{RD}}, defined below. | Broadway |</span><br><span style="color: hsl(120, 100%, 40%);">+| PRD | Leading street direction| N, W |</span><br><span style="color: hsl(120, 100%, 40%);">+| POD | Trailing street direction| SW |</span><br><span style="color: hsl(120, 100%, 40%);">+| STS | Street suffix | Avenue, Platz, Street|</span><br><span style="color: hsl(120, 100%, 40%);">+| HNO | House number, numeric part only|123|</span><br><span style="color: hsl(120, 100%, 40%);">+| HNS | House number suffix | A, 1/2 |</span><br><span style="color: hsl(120, 100%, 40%);">+| LMK | Landmark or vanity address|Low Library |</span><br><span style="color: hsl(120, 100%, 40%);">+| LOC | Additional location information\\NOTE: {{ROOM}} was added below.| Room 543 |</span><br><span style="color: hsl(120, 100%, 40%);">+| FLR | Floor | 5 |</span><br><span style="color: hsl(120, 100%, 40%);">+| NAM | Name (residence, business or office occupant)|Joe's Barbershop |</span><br><span style="color: hsl(120, 100%, 40%);">+| PC | Postal code | 10027-0401 |</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+These codes were added in [RFC5139|Geolocation#rfc5139]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+|| Label || Description || Example |</span><br><span style="color: hsl(120, 100%, 40%);">+| BLD | Building (structure) | Hope Theatre |</span><br><span style="color: hsl(120, 100%, 40%);">+| UNIT | Unit (apartment, suite) | 12a |</span><br><span style="color: hsl(120, 100%, 40%);">+| ROOM | Room | 450F |</span><br><span style="color: hsl(120, 100%, 40%);">+| PLC | Place-type | office |</span><br><span style="color: hsl(120, 100%, 40%);">+| PCN | Postal community name | Leonia |</span><br><span style="color: hsl(120, 100%, 40%);">+| POBOX | Post office box (P.O. box) | U40 |</span><br><span style="color: hsl(120, 100%, 40%);">+| ADDCODE | Additional Code | 13203000003 |</span><br><span style="color: hsl(120, 100%, 40%);">+| SEAT | Seat (desk, cubicle, workstation) | WS 181 |</span><br><span style="color: hsl(120, 100%, 40%);">+| RD | Primary road or street | Broadway |</span><br><span style="color: hsl(120, 100%, 40%);">+| RDSEC | Road section | 14 |</span><br><span style="color: hsl(120, 100%, 40%);">+| RDBR | Road branch | Lane 7 |</span><br><span style="color: hsl(120, 100%, 40%);">+| RDSUBBR | Road sub-branch | Alley 8 |</span><br><span style="color: hsl(120, 100%, 40%);">+| PRM | Road pre-modifier | Old |</span><br><span style="color: hsl(120, 100%, 40%);">+| POM | Road post-modifier | Service |</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+These codes were added in [RFC6848|Geolocation#rfc6848]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+|| Label || Description || Example |</span><br><span style="color: hsl(120, 100%, 40%);">+|PN|Post number that is attributed to a lamp post or utility pole.|21344567|</span><br><span style="color: hsl(120, 100%, 40%);">+|MP|Milepost: a marker indicating distance to or from a place (often a town)</span><br><span style="color: hsl(120, 100%, 40%);">+May actually be expressed in "miles" or "kilometers".|237.4|</span><br><span style="color: hsl(120, 100%, 40%);">+|STP|Street Type Prefix.|Boulevard|</span><br><span style="color: hsl(120, 100%, 40%);">+|HNP|House Number Prefix.|Z|</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h1. Example Configurations</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h2. Simple Example 1</span><br><span style="color: hsl(120, 100%, 40%);">+In geolocation.conf, we can define a location that descibes a building and profiles for Bob and Alice that add floor and room.  We're assuming here that Bob's and Alice's phones don't send any location information themselves.</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+[building1]</span><br><span style="color: hsl(120, 100%, 40%);">+type = location</span><br><span style="color: hsl(120, 100%, 40%);">+format = civicAddress</span><br><span style="color: hsl(120, 100%, 40%);">+location_info = country=US, A1="New York", A3="New York",</span><br><span style="color: hsl(120, 100%, 40%);">+location_info = HNO=1633, PRD=W, RD=46th, STS=Street, PC=10222</span><br><span style="color: hsl(120, 100%, 40%);">+method = Manual</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+[alice]</span><br><span style="color: hsl(120, 100%, 40%);">+type = profile</span><br><span style="color: hsl(120, 100%, 40%);">+location_reference = building1</span><br><span style="color: hsl(120, 100%, 40%);">+location_refinement = FLR=4, ROOM=4B20</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+[bob]</span><br><span style="color: hsl(120, 100%, 40%);">+type = profile</span><br><span style="color: hsl(120, 100%, 40%);">+location_reference = building1</span><br><span style="color: hsl(120, 100%, 40%);">+location_refinement = FLR=32, ROOM=32A6</span><br><span style="color: hsl(120, 100%, 40%);">+{code}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h1. PIDF-LO XML Examples</span><br><span>\ No newline at end of file</span><br><span>diff --git a/res/res_geolocation/wiki/GML.md b/res/res_geolocation/wiki/GML.md</span><br><span>new file mode 100644</span><br><span>index 0000000..e69de29</span><br><span>--- /dev/null</span><br><span>+++ b/res/res_geolocation/wiki/GML.md</span><br><span>diff --git a/res/res_geolocation/wiki/Geolocation.md b/res/res_geolocation/wiki/Geolocation.md</span><br><span>new file mode 100644</span><br><span>index 0000000..7674dd2</span><br><span>--- /dev/null</span><br><span>+++ b/res/res_geolocation/wiki/Geolocation.md</span><br><span>@@ -0,0 +1,19 @@</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The Geolocation capabilities are inplmented in Asterisk with the res_geolocation and res_pjsip_geolocation modules</span><br><span style="color: hsl(120, 100%, 40%);">+and the geolocation.conf configuration file.  Geolocation isn't a trivial concept however so before reading further, please familiarize yourself with the following documents:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+|| RFC || Title ||</span><br><span style="color: hsl(120, 100%, 40%);">+|[RFC3693|https://www.rfc-editor.org/rfc/rfc3693]|Geopriv Requirements|</span><br><span style="color: hsl(120, 100%, 40%);">+|[RFC4119|https://www.rfc-editor.org/rfc/rfc4119]|A Presence-based GEOPRIV Location Object Format|</span><br><span style="color: hsl(120, 100%, 40%);">+|[RFC5139|https://www.rfc-editor.org/rfc/rfc5139]|Revised Civic Location Format for\\Presence Information Data Format Location Object (PIDF-LO)|</span><br><span style="color: hsl(120, 100%, 40%);">+|{anchor:rfc5491}[RFC5491|https://www.rfc-editor.org/rfc/rfc5491]|GEOPRIV Presence Information Data Format\\Location Object (PIDF-LO) Usage Clarification, Considerations, and Recommendations|</span><br><span style="color: hsl(120, 100%, 40%);">+|[RFC5808|https://www.rfc-editor.org/rfc/rfc5808]|Requirements for a Location-by-Reference Mechanism|</span><br><span style="color: hsl(120, 100%, 40%);">+|[RFC6280|https://www.rfc-editor.org/rfc/rfc6280]|An Architecture for Location and Location\\Privacy in Internet Applications|</span><br><span style="color: hsl(120, 100%, 40%);">+|{anchor:rfc6442}[RFC6442|https://www.rfc-editor.org/rfc/rfc6442]|Location Conveyance for the Session Initiation Protocol|</span><br><span style="color: hsl(120, 100%, 40%);">+|[RFC6848|https://www.rfc-editor.org/rfc/rfc6848]|Specifying Civic Address Extensions in the\\Presence Information Data Format Location Object (PIDF-LO)|</span><br><span style="color: hsl(120, 100%, 40%);">+|[RFC7459|https://www.rfc-editor.org/rfc/rfc7459]|Representation of Uncertainty and Confidence\\in the Presence Information Data Format Location Object (PIDF-LO)|</span><br><span style="color: hsl(120, 100%, 40%);">+|[RFC8787|https://www.rfc-editor.org/rfc/rfc8787]|Location Source Parameter for the SIP Geolocation Header Field|</span><br><span style="color: hsl(120, 100%, 40%);">+|[OGC GML|https://www.ogc.org/standards/gml]|Open Geospatial Consortium Geography Markup Language|</span><br><span style="color: hsl(120, 100%, 40%);">+|{anchor:geoshape}[GeoShape|https://portal.ogc.org/files/?artifact_id=21630#:~:text=This%20GML%203.1.,uses%20the%20separately%20specified%20geoshape]|GML 3.1.1 PIDF-LO Shape Application Schema\\for use by the Internet Engineering Task Force (IETF)|</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+There is no single document that has the complete, current specification so please follow and read any "updated by" references in these documents.</span><br><span>diff --git a/res/res_geolocation/wiki/LocationConcepts.md b/res/res_geolocation/wiki/LocationConcepts.md</span><br><span>new file mode 100644</span><br><span>index 0000000..cf2714d</span><br><span>--- /dev/null</span><br><span>+++ b/res/res_geolocation/wiki/LocationConcepts.md</span><br><span>@@ -0,0 +1,30 @@</span><br><span style="color: hsl(120, 100%, 40%);">+h2. Describing a Location</span><br><span style="color: hsl(120, 100%, 40%);">+There are currently two ways to describe a location.</span><br><span style="color: hsl(120, 100%, 40%);">+h3. Geography Markup Language (GML)</span><br><span style="color: hsl(120, 100%, 40%);">+GML allows you to express a location in terms of shapes, coordinates, lengths, angles, etc.  For example, a Point with a latitude, longitude and altitude, or a Sphere with a latitude, longitude, altitude and radius. Other shapes include, Circle, Polygon, Ellipse, Ellipsoid, and Prism.  See [GeoShape|Geolocation#geoshape] above.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+GML would most often be used by mobile systems where the originator's location is determined dynamically such as base station, sector antenna, distance, etc.  According to [RFC4119|Geolocation#rfc4119] GML is considered to be the "baseline" format and MUST be supported by all implementations.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h3. Civic Address</span><br><span style="color: hsl(120, 100%, 40%);">+For fixed locations, Civic Address is probably the most used location description method.  It's described with terms like Country, State/Province, City, Neighborhood, Street, House Number, Floor, Room, etc.  Support for Civic Address is NOT required by [RFC4119|Geolocation#rfc4119].</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Both methods are expressed in XML but which location description method you use is entirely between you and your partners.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h3. PIDF-LO</span><br><span style="color: hsl(120, 100%, 40%);">+The IETF chose the "Presence Information Data Format" (PIDF) as the wrapper document for location information and can be placed in {{<tuple>}}, {{<device>}}, or {{<person>}} elements.  The specification allows multiple locatons in each element and also allows multiple elements in a single PIDF-LO document.  Dealing with multiple locations however is an extraordinarily complex process and should be avoided when possible.  Please read the reference information for the applicable rules.  [RFC5491|Geolocation#rfc5491] is a good starting point.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h2. Conveying a Location via SIP</span><br><span style="color: hsl(120, 100%, 40%);">+There are currently two ways to convey a location description regardless of which description method you use.  Both use the {{Geolocation}} SIP message header to indicate where to get the location description document.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h3. By Reference</span><br><span style="color: hsl(120, 100%, 40%);">+This one's simple.  The "reference" is actually URI that the recipient can access that will return an XML document containing the description.  "http" and "https" are the most common URI schemes but there are others.  See [RFC6442|Geolocation#rfc6442] above.  An example {{Geolocation}} header might look like: {{Geolocation: <https://geoloc.example.com?location=some_location_reference>}}.  More on {{location=some_location_reference}} later.</span><br><span style="color: hsl(120, 100%, 40%);">+With this method, you are entirely responsible for retrieving location descriptions from URIs you receive and for serving location descriptions for URIs you send.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h3. By Value</span><br><span style="color: hsl(120, 100%, 40%);">+This method involves sending or receiving a PIDF-LO document attached to a SIP message. For details on how this works generally, See [RFC6442|Geolocation#rfc6442] and [RFC5491|Geolocation#rfc5491] above.  An example {{Geolocation}} header might look like: {{Geolocation: <cid:gyytfr@your.pbx.com>}}.  The {{cid}} scheme indicates that the recipient should look in the SIP message body (or bodies since there could also be an SDP for example) for the location document.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h3. Multiple URIs</span><br><span style="color: hsl(120, 100%, 40%);">+The {{Geolocation}} header can contain multiple URIs and they can be a mix of "by-reference" and "by-value".</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+h3. Geolocation-Routing</span><br><span style="color: hsl(120, 100%, 40%);">+[RFC6442|Geolocation#rfc6442] also defines the {{Geolocation-Routing}} header which indicates to a recipient that the location information may or may not be used for call routing purposes.  If set to "no" (the default if absent), the recipient MUST NOT use the location information for routing purposes.  If set to "yes", the recipient MAY use the location information for routing purposes and may also reset the value to "no" to prevent downstream systems from using the location information for routing.</span><br><span>diff --git a/res/res_geolocation/wiki/URI.md b/res/res_geolocation/wiki/URI.md</span><br><span>new file mode 100644</span><br><span>index 0000000..e69de29</span><br><span>--- /dev/null</span><br><span>+++ b/res/res_geolocation/wiki/URI.md</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/18360">change 18360</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/c/asterisk/+/18360"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: development/16/geolocation </div>
<div style="display:none"> Gerrit-Change-Id: I85b239776209bff3fc3388cf9b0a322a1764db29 </div>
<div style="display:none"> Gerrit-Change-Number: 18360 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: George Joseph <gjoseph@digium.com> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>