[Asterisk-code-review] res_geolocation: Update wiki documentation (asterisk[19])
George Joseph
asteriskteam at digium.com
Tue Sep 27 10:02:55 CDT 2022
George Joseph has uploaded this change for review. ( https://gerrit.asterisk.org/c/asterisk/+/19377 )
Change subject: res_geolocation: Update wiki documentation
......................................................................
res_geolocation: Update wiki documentation
Change-Id: I89c3c5db8c0701b33127993622d5e4f904bddfbc
---
M res/res_geolocation/wiki/AsteriskImplementation.md
M res/res_geolocation/wiki/GML.md
M res/res_geolocation/wiki/Geolocation.md
M res/res_geolocation/wiki/URI.md
4 files changed, 224 insertions(+), 73 deletions(-)
git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/77/19377/1
diff --git a/res/res_geolocation/wiki/AsteriskImplementation.md b/res/res_geolocation/wiki/AsteriskImplementation.md
index ec1dad6..227cb88 100644
--- a/res/res_geolocation/wiki/AsteriskImplementation.md
+++ b/res/res_geolocation/wiki/AsteriskImplementation.md
@@ -21,7 +21,7 @@
h2. Common Behavior
h3. Sub-parameters
-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.
+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. For instance, a GML Circle might look like this:
{code}
location_info = shape=Circle, pos="39.12345 -105.98766", radius=100
{code}
@@ -30,11 +30,11 @@
For readability, parameters that use sub-parameters can be split over more than one line. For example:
{code}
location_info = country=US,A1="New York"
-location_info = house_number=1633,PRD=W,street=46th
+location_info = HNO=1633,PRD=W,RD=46th
{code}
would be equivalent to:
{code}
-location_info = country=US,A1="New York",house_number=1633,PRD=W,street=46th
+location_info = country=US,A1="New York",HNO=1633,PRD=W,RD=46th
{code}
h3. Variable substitution
@@ -46,79 +46,200 @@
You can also use dialplan functions such as {{CURL}} and {{ODBC_SQL}} to supply values just as you would in extensions.conf.
-h2. Location
+h2. Configuration Objects
+h3. Location
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.
-||Parameter||Required?||Uses Channel\\Variables?||Uses Sub\\Parameters?||Usage||
-|type|yes|no|no|Must be "location"|
-|format|yes|no|no|"civicAddress", "GML" or "URI" to indicate how the location is expressed.|
-|method|no|no|no|If provided, it MUST be one of "GPS", "A-GPS", "Manual", "DHCP", "Triangulation", "Cell", "802.11"|
-|location_source|no|no|no|If provided, it MUST be a fully qualified domain name. IP addresses are specifically not allowed.
-See [RFC8787|Geolocation Reference Information#rfc8787] for the exact definition of this parameter.|
-|location_info|yes|yes|yes|The sub-parameters of location_info are dependent on the location's format:
-* URI: A single {{URI}} sub-parameter with the URI.
-Example: {{location_info = URI=http://some.example.com}}
-See the [URI] page for more info.
-* civicAddress: A set of sub-parameters that describe the location.
-Example:
+
+h4. Parameters
+
+* *type*: Object type. Must be "location"
+** Required: yes
+** Uses channel variables: no
+** Sub-parameters: none
+** Default: none
+** Example:
+ {{type=location}}
+
+* *format*: Must be one of "civicAddress", "GML" or "URI" to indicate how the location is expressed.
+** Required: yes
+** Uses channel variables: no
+** Sub-parameters: none
+** Default: none
+** Example:
+ {{format=civicAddress}}
+
+* *method*: If provided, it MUST be one of "GPS", "A-GPS", "Manual", "DHCP", "Triangulation", "Cell", "802.11"
+** Required: no
+** Uses channel variables: no
+** Sub-parameters: none
+** Default: none
+** Example:
+ {{method=Manual}}
+
+* *location_source*: If provided, it MUST be a fully qualified domain name. IP addresses are specifically not allowed. See [RFC8787|Geolocation Reference Information#rfc8787] for the exact definition of this parameter.
+** Required: no
+** Uses channel variables: no
+** Sub-parameters: none
+** Default: none
+** Example:
+ {{location_source=some.domain.net}}
+
+* *location_info*: Sub-parameters that describe the location. Dependent on the format selected.
+** Required: yes
+** Uses channel variables: yes
+** Sub-parameters: yes
+** Default: none
+** Examples:
+*** [URI] format: (see the [URI] page for more info)
+ {{location_info = URI=http://some.example.com}}
+*** [civicAddress|Civic Address] format: ( See the [civicAddress|Civic Address] page for more info)
+ {{location_info = country=US, A1="New York", A3="New York", ...}}
+*** [GML|Geography Markup Language] format: (See the [GML|Geography Markup Language] page for more info)
+ {{location_info = shape=Circle, pos="39.12345 -105.98766", radius=100}}
+
+* *confidence*: This is a rarely used field in the specification that would indicate the confidence in the location specified. See [RFC7459|https://www.rfc-editor.org/rfc/rfc7459] for exact details.
+** Required: no
+** Uses channel variables: no
+** Sub-parameters: yes
+*** *pdf*: One of: "unknown", "normal", "rectangular".
+*** *value*: 0-100 percent indicating the confidence level.
+** Default: none
+** Example:
+ {{confidence = pdf=normal, confidence=95
+
+h4. Example
+
{code}
-location_info = country=US,A1="New York",A3="New York"
-location_info = house_number=1633,PRD=W,street=46th
-location_info = street_suffix = Street,postal_code=10222
+[mylocation]
+type = location
+format = civicAddress
+method = Manual
+location_info = country=US, A1="New York", A3="New York",
+location_info = HNO=1633, PRD=W, RD=46th, STS=Street, PC=10222
{code}
-See the [Civic Address] page for more info.
-* GML: A set of sub-parameters that describe the location.
-Example: {{location_info = shape=Circle, pos="39.12345 -105.98766", radius=100}}
-See the [GML] page for more info.|
-|confidence|no|no|yes|This is a rarely used field in the specification that would indicate the confidence in the location specified. See [RFC7459|https://www.rfc-editor.org/rfc/rfc7459] for exact details.
-Sub-parameters:
-* {{pdf}}: One of: "unknown", "normal", "rectangular".
-* {{value}}: A percentage indicating the confidence.
-|
-h2. Profile
+h3. Profile
The Profile object defines how a location is used and is referenced by channel drivers.
-||Parameter||Required?||Uses Channel\\Variables?||Uses Sub\\Parameters?||Usage||
-|type|yes|no|no|Must be "profile"|
-|location_reference|no|no|no|Specifies the id of a Location object to use.|
-|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".|
-|allow_routing_use|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".
-See [RFC6442|Geolocation Reference Information#rfc6442] for more information.|
-|profile_precedence|no|no|no|Specifies which of the available profiles (configured or incoming) takes precedence.\\
-NOTE: On an incoming call leg/channel, the "incoming" profile is the one received by the channel driver from the calling party in the SIP INVITE and the "configured" profile is the one attached to the calling party's pjsip endpoint. On an outgoing call segment/channel, the "incoming" profile is the one received by the channel driver from the Asterisk core/dialplan and the "configured" profile one is the one attached to the called party's pjsip endpoint.
-* {{prefer_incoming}}: Use the incoming profile if it exists and has location information, otherwise use the configured profile if it has location information. If neither profile has location information, nothing is sent.
-* {{force_incoming}}: Discard any configured profile and use the incoming profile if it exists and it has location information. If the incoming profile doesn't exist or has no location information, nothing is sent.
-* {{prefer_config}}: Use the configured profile if it exists and has location information, otherwise use the incoming profile if it exists and has location information. If neither profile has location information, nothing is sent.
-* {{force_config}}: Discard any incoming profile and use the configured profile if it exists and it has location information. If the configured profile doesn't exist or has no location information, nothing is sent.
-|
-|usage_rules|no|yes|yes|For Civic Address and GML location formats, this parameter specifies the contents of the {{usage-rules}} PIDF-LO element.\\
-* {{retransmission-allowed}}: Must be "yes" or "no". The default is "no".\\
-* {{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:
-{{retention-expires="$\{STRFTIME($[$\{EPOCH\}+3600],UTC,%FT%TZ)\}"}}\\
-See [RFC4119|Geolocation Reference Information#rfc4119] for the exact definition of this parameter.
-|
-|location_info_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.
-|location_variables|no|yes|yes|Any parameter than can use channel variables can also use the 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 other parameter that can accept channel variables|
-|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.|
+h4. Parameters
+
+* *type*: Object type. Must be "profile"
+** Required: yes
+** Uses channel variables: no
+** Sub-parameters: none
+** Default: none
+** Example:
+ {{type=profile}}
+
+* *location_reference*: Specifies the id of a Location object to use.
+** Required: no
+** Uses channel variables: no
+** Sub-parameters: none
+** Default: none
+** Example:
+ {{location_reference=mylocation}}
+
+* *pidf_element*: 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".
+** Required: no
+** Uses channel variables: no
+** Sub-parameters: none
+** Default: device
+** Example:
+ {{pidf_element = tuple}}
+
+* *allow_routing_use*: This value controls the value of the {{Geolocation-Routing}} header sent on SIP requests, Must be "yes" or "no". See [RFC6442|Geolocation Reference Information#rfc6442] for more information.
+** Required: no
+** Uses channel variables: no
+** Sub-parameters: none
+** Default: no
+** Example:
+ {{allow_routing_use = yes}}
+
+* *profile_precedence*: Specifies which of the available profiles (configured or incoming) takes precedence. NOTE: On an incoming call leg/channel, the "incoming" profile is the one received by the channel driver from the calling party in the SIP INVITE and the "configured" profile is the one attached to the calling party's pjsip endpoint. On an outgoing call segment/channel, the "incoming" profile is the one received by the channel driver from the Asterisk core/dialplan and the "configured" profile one is the one attached to the called party's pjsip endpoint.
+** Valid values:
+*** {{prefer_incoming}}: Use the incoming profile if it exists and has location information, otherwise use the configured profile if it has location information. If neither profile has location information, nothing is passed on.
+*** {{prefer_config}}: Use the configured profile if it exists and has location information, otherwise use the incoming profile if it has location information. If neither profile has location information, nothing is passed on.
+*** {{discard_incoming}}: Discard the incoming profile and use the configured profile if it has location information. If it doesn't, nothing is passed on.
+*** {{discard_config}}: Discard the configured profile and use the incoming profile if it has location information. If it doesn't, nothing is passed on.
+** Required: no
+** Uses channel variables: no
+** Sub-parameters: none
+** Default: discard_incoming
+** Example:
+ {{profile_precedence = prefer_incoming}}
+
+* *usage_rules*: For Civic Address and GML location formats, this parameter specifies the contents of the {{usage-rules}} PIDF-LO element. See [RFC4119|Geolocation Reference Information#rfc4119] for the exact definition of this parameter.
+** Required: no
+** Uses channel variables: yes
+** Sub-parameters: yes
+*** *retransmission-allowed*: Must be "yes" or "no".
+*** *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.
+** Default: retransmission-allowed=no, retention-expires=<current time + 24 hours>
+** Example:
+ {{usage_rules = retransmission-allowed=yes,retention-expires="$\{STRFTIME($[$\{EPOCH\}+3600],UTC,%FT%TZ)\}"}}
+
+* *location_info_refinement*: 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.
+** Required: no
+** Uses channel variables: yes
+** Sub-parameters: yes (any that can appear in a location's location_info parameter)
+** Default: none
+** Example:
+ Add a room to the civicAddress specified by location_reference.
+ {{location_reference = myCivicAddress = ROOM=23A4}}
+ {{location_info_refinement = ROOM=23A4}}
+
+* *location_variables*: Any parameter than can use channel variables can also use the 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 other parameter that can accept channel variables.
+** Required: no
+** Uses channel variables: yes
+** Sub-parameters: yes (one or more name=value pairs)
+** Default: none
+** Example:
+ {{location_variables = MYVAR1=something, MYVAR2="something else"}}
+
+* *notes*: 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.
+** Required: no
+** Uses channel variables: no
+** Sub-parameters: no
+** Default: none
+** Example:
+ {{notes = "anything you want"}}
+
+h4. Additional Parameters
+In addition to the profile-specific parameters defined above, any location-object parameters can be specified as well. This is a convenient shortcut if you have a 1<>1 relationship between profile and location.
+
+h4. Built-in Profiles
+In addition to the profiles you define in geolocation.conf, 4 built-in profiles are also available They're named after their profile_precedence setting:
+* *<prefer_incoming>*
+* *<prefer_config>*
+* *<discard_incoming>*
+* *<discard_config>*
+
+The rest of the profile parameters are set to their defaults.
h1. chan_pjsip Configuration
Two new parameters have been added to pjsip endpoints:
-||Parameter||Usage||
-|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.|
-|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 and not conveyed to the endpoint.|
-h1. Dialplan Applications and Functions
-Two new dialplan applications and one dialplan function have been added to allow a dialplan author to manipulate geolocation information.
+h2. Parameters
-h2. GeolocProfileCreate
-This application creates a new Geolocation profile on the channel in addition to any others that may already exist. It tasks a profile name and an index as its arguments. Callers must use the {{GEOLOC_PROFILE}} function to set its actual location description.
+* *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. Any of the 4 built-in profiles can be used.
-h2. GeolocProfileDelete
-This application deletes the existing Geolocation profile at the specified index from the channel's list of profiles.
+* *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 and not conveyed to the endpoint. Any of the 4 built-in profiles can be used.
+
+Example:
+{code}
+[myendpoint]
+type = endpoint
+...
+geoloc_incoming_call_profile = <discard_incoming>
+geoloc_outgoing_call_profile = myendpoint_profile
+{code}
+
+h1. Dialplan Function
+A new dialplan function has been added to allow a dialplan author to manipulate geolocation information.
h2. GEOLOC_PROFILE
-This function can get or set any of the fields in a specific profile. The available fields are those in _both_ the Location and Profile configuration objects.
+This function can get or set any of the fields in a specific profile. The available fields are those in _both_ the Location and Profile configuration objects. See the fuinction help for more information.
h1. Example Call Flows
diff --git a/res/res_geolocation/wiki/GML.md b/res/res_geolocation/wiki/GML.md
index 394f1c2..c1b1a71 100644
--- a/res/res_geolocation/wiki/GML.md
+++ b/res/res_geolocation/wiki/GML.md
@@ -16,7 +16,7 @@
h2. Units of Measure
h3. Position
-Positions are always specified in decimal degrees latitude and longitude. A 3d position adds the altitude in meters. `pos` and `posList` are the two attributes that specify position.
+Positions are always specified in decimal degrees latitude and longitude. A 3d position adds the altitude in meters. `pos` and `pos3d` are the two attributes that specify position.
h3. Distance
Distance is _always_ specified in meters. `height`, `radius` and the altitude component of `pos` are some of the distance attributes.
@@ -29,22 +29,44 @@
Angle may be specified in either degrees or radians by specifying the `degrees` or `radians` suffix to the angle value. The default it `degrees` if no suffix is provided. `orientation`, `startAngle` and `openingAngle` are some of the angle attributes.
h2. Shapes
-h3. Point
-A Point isn't really a "shape" because it's a one dimensional construct but we'll ignore that. It's simply a point in space specified with either two or three dimensions.
+See the references above for the exact shape definitions.
+|| Shape || Attributes ||
+| Point | pos or pos3d |
+| Circle | pos or pos3d, radius |
+| Sphere | pos3d, radius |
+| Ellipse| pos or pos3d, semiMajorAxis, semiMinorAxis, orientation |
+| ArcBand | pos or pos3d, innerRadius, outerRadius, startAngle, openingAngle |
+| Ellipsoid | pos3d, semiMajorAxis, semiMinorAxis, verticalAxis, orientation |
+| Polygon | 3 or more pos or pos3d |
+| Prism | 3 or more pos3d, height |
-|| Shape || Attributes || Description ||
-| Point | pos or pos3d | A single point |
-| Circle | pos or pos3d, radius | A two dimensional circle around a point |
-| Sphere | pos3d, radius | A 3 dimensional sphere around a point |
-
|| Attribute || Description || Units || Example ||
| pos | A two dimensional point | Decimal degrees | pos="39.12345 -105.98766" |
| pos3d | A three dimensional point | Decimal degrees + altitude in meters | pos="39.12345 -105.98766 1690" |
| radius | Distance | Meters | radius="20" |
| height | Distance | Meters | height="45" |
| orientation | Angle | Degrees (default) or Radians | orientation="90", orientation="25 radians" |
+| semiMajorAxis | Distance | Meters | semiMajorAxis="145" |
+| semiMinorAxis | Distance | Meters | semiMinorAxis="145" |
+| innerRadius | Distance | Meters | innerRadius="350" |
+| outerRadius | Distance | Meters | outerRadius="350" |
+| verticalAxis | Distance | Meters | verticalAxis="20" |
+
+h2. Examples:
+
+{code}
+location_info = shape=Point, crs=2d, pos="39.12345 -105.98766"
+location_info = shape=Point, crs=3d, pos="39.12345 -105.98766 1892.0"
+location_info = shape=Circle, crs=2d, pos="39.12345 -105.98766" radius="45"
+location_info = shape=Sphere, crs=3d, pos="39.12345 -105.98766 1902" radius="20"
+location_info = shape=Ellipse, crs=2d, pos="39.12345 -105.98766" semiMajorAxis="20", semiMinorAxis="10", orientation="25 radians"
+location_info = shape=ArcBand, crs=2d, pos="39.12345 -105.98766" innerRadius="1200", outerRadius="1500", startAngle="90", openingAngle="120"
+location_info = shape=Polygon, crs=2d, pos="39.12345 -105.98766", pos=40.7890 -105.98766", pos="40.7890 -106.3456", pos=39.12345 -106.3456"
+location_info = shape=Prism, crs=3d, pos="39.12345 -105.98766 1890", pos="40.7890 -105.98766 1890", pos="40.7890 -106.3456 1890", pos=39.12345 -106.3456 1890", height="45"
+{code}
+
{column}
{column:width=30%}
diff --git a/res/res_geolocation/wiki/Geolocation.md b/res/res_geolocation/wiki/Geolocation.md
index 8921978..f43343f 100644
--- a/res/res_geolocation/wiki/Geolocation.md
+++ b/res/res_geolocation/wiki/Geolocation.md
@@ -55,7 +55,7 @@
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 Reference Information#rfc6442] and [RFC5491|Geolocation Reference Information#rfc5491]. An example {{Geolocation}} header might look like: {{Geolocation: <cid:gyytfr at 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.
h3. Multiple URIs
-The {{Geolocation}} header can contain multiple URIs and they can be a mix of "by-reference" and "by-value". As mentioned above though, the process of dealing with multiple location references is pretty complex and should be avoided.
+Technically, the {{Geolocation}} header can contain multiple URIs and they can be a mix of "by-reference" and "by-value". The process of dealing with multiple location references is _very_ complex however and should be avoided.
h3. Geolocation-Routing
[RFC6442|Geolocation Reference Information#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.
diff --git a/res/res_geolocation/wiki/URI.md b/res/res_geolocation/wiki/URI.md
index 91d832f..ad4b83a 100644
--- a/res/res_geolocation/wiki/URI.md
+++ b/res/res_geolocation/wiki/URI.md
@@ -56,9 +56,8 @@
; the outgoing channel when 911 is dialed and does nothing if another number is dialed.
[pre-dial-handler]
exten = 911,1,NoOp(Entering PDH for Outgoing Channel)
-same = n,GeolocProfileCreate(geoloc.example at myserver.com)
-same = n,Set(GEOLOC_PROFILE(format,0)=URI)
-same = n,Set(GEOLOC_PROFILE(location_info,0)=URI=https://my.company.com/location_query?DID=${CALLERID(num)})
+same = n,Set(GEOLOC_PROFILE(format)=URI)
+same = n,Set(GEOLOC_PROFILE(location_info)=URI=https://my.company.com/location_query?DID=${CALLERID(num)})
same = n,Return(0)
exten = _X.,1,Return(0)
--
To view, visit https://gerrit.asterisk.org/c/asterisk/+/19377
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings
Gerrit-Project: asterisk
Gerrit-Branch: 19
Gerrit-Change-Id: I89c3c5db8c0701b33127993622d5e4f904bddfbc
Gerrit-Change-Number: 19377
Gerrit-PatchSet: 1
Gerrit-Owner: George Joseph <gjoseph at digium.com>
Gerrit-MessageType: newchange
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20220927/959563d2/attachment-0001.html>
More information about the asterisk-code-review
mailing list